Next.js example for Selvklart

Included

• Next JS and configured next.config with SWC support
• MUI (or Joy) with configured emotion cache and SWR support
• Editorconfig for Selvklart projects
• Eslint based on Selvklart Eslint

Local development

To be able to work on the project locally, you'll need to set up a few things first.

Pre-requisites

• Git
• Node.js v16 or higher
• GitHub CLI (optional)

Creating a new project

The project can be created from any directory you want, so where you install it is up to you. The command will prompt you for a project name.

cd ~/<your project dir>
npx create-next-app@latest -e https://github.com/selvklart/selvklart-nextjs-example

This will pull down the project and ask for a project name. Upon completion you will have a ready to go NextJS project with certain Selvklart additions.

Next steps

1. Create a Github project using the web or CLI

    gh repo create selvklart/<app name>

2. Initialize the app folder

    cd ~/<your project dir> && git init -b main

3. Add and commit the files

    git add . && git commit -m "Initial Selvklart Next Example commit"

4. Push the commit to the repo

    git remote add origin <REMOTE_URL>
    # Sets the new remote
    git remote -v
    # Verifies the new remote URL
    git push -u origin main
    # Pushes the changes in your local repository up to the remote repository you specified as the origin

Your new project is now ready - happy coding!

Editing the example TODO

TODO

• Agree on best practices and add it to this repo
• Create Klart project example?
• Add better readme