diff --git a/.github/workflows/markdown_format.yml b/.github/workflows/markdown_format.yml new file mode 100644 index 0000000..ddb7f71 --- /dev/null +++ b/.github/workflows/markdown_format.yml @@ -0,0 +1,18 @@ +name: markdown check + +on: + pull_request: + paths: + - '**/*.md' +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Code checkout + uses: actions/checkout@v4 + + - name: markdownlint-cli + uses: DavidAnson/markdownlint-cli2-action@v14 + with: + globs: '**/*.md' diff --git a/README.md b/README.md index 5ce6766..171c61d 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,70 @@ -# create-svelte +# Profilator -Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte). +[![Made with SvelteKit](https://img.shields.io/badge/Made%20with-SvelteKit-orange)](https://kit.svelte.dev/) +[![Styled with Tailwind CSS](https://img.shields.io/badge/Styled%20with-Tailwind%20CSS-blue)](https://tailwindcss.com/) +[![TypeScript](https://img.shields.io/badge/TypeScript-Yes-blue)](https://www.typescriptlang.org/) +[![Formatted with Prettier](https://img.shields.io/badge/Formatted%20with-Prettier-ff69b4)](https://prettier.io/) +[![Linted with ESLint](https://img.shields.io/badge/Linted%20with-ESLint-4B32C3)](https://eslint.org/) -## Creating a project +This is a sanakan profile customization and preview page. +Written in SvelteKit using Canvas. +Allows users to customize their profiles for the PocketWaifu display on discord. -If you're seeing this, you've probably already done this step. Congrats! +Reference: -```bash -# create a new project in the current directory -npm create svelte@latest - -# create a new project in my-app -npm create svelte@latest my-app -``` +- [Sanakan](https://github.com/MZKNEK/sanakan) +- [PocketWaifu](https://github.com/Sygnator/waifu-site) ## Developing -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: +1. Clone git repository -```bash -npm run dev + ```sh + git clone git@github.com:Sygnator/pocketwaifu-profile-customization.git + ``` -# or start the server and open the app in a new browser tab -npm run dev -- --open -``` +1. Install dependencies + + ```sh + pnpm Install + ``` + +1. Start a development server + + ```sh + pnpm dev + ``` + +### Additional Scripts + +1. To check for linting issues + + ```sh + pnpm run lint + ``` + +1. To format the code + + ```sh + pnpm run format + ``` ## Building To create a production version of your app: -```bash -npm run build +```sh +pnpm run build ``` -You can preview the production build with `npm run preview`. +You can preview the production build with `pnpm run preview`. + +The `master` branch is automatically deployed to the server upon any changes. + +## Contributions are welcome -> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment. +1. Fork the repository. +1. Create a new branch (`git checkout -b feature/improvement`) +1. Commit your changes (`git commit -m 'Add some feature'`) +1. Push to the branch (`git push origin feature/improvement`) +1. Create a new Pull Request.