This Next.js project was bootstrapped with with create-next-app.

Working with NPM/etc

There are other tools like npm such as yarn, pnpm, and bun but for this project it used npm.

You'll need the following:

• npm aka 'Node Package Manager'
• Node you'll likly need this too
• An IDE or "Intelligent Development Environment", basically some form of code editor such as:
  • Visual Studio Code
    • Recommend you add some Extensions, you can do this within VSC
      • Error Lens adds overlaid explanations of errors and makes it easier to not miss them
      • In your Face is a fun extension that keeps you aware of errors in your current file
• A GIT Account

Working on the Project

The project is a React App which makes use of Next.js for routing and various other benefits. The components used leverage Material UI.

The project is written in TypeScript to reduce errors and improve workflow.

If you wish to work on the project, you can clone it down and get started on your own branch, note deploying changes is dependent on pushes/merges to the main branch which is protected and requires a Pull Request approval from the repo owner; basically if Yinoguns approves the change, e.g. it is stable, worthwhile, and well enough written then it can be merged.

Make sure you are familiar:

• React
• TypeScript
• Next.js
  • Server Side Rendering is enabled on this project.
• Git
  • Flow
  • Cloning
  • Pulling
  • Branching
  • Commiting
  • Pushing
  • Pull Requests

Yinoguns' personally makes use of Sourcetree a free to use and intuative GUI for GIT management.

Onto Developing

First, clone the repo.

Second, install node modules: npm i if you have not worked with node before, see Working with NPM/etc

To run the application use npm run dev

Open http://localhost:3000 with your browser to see the result.

Now all you need to do is make code changes, new files, etc and it will hot-reload the changes, if something odd happens, stopping (CTRL+C in the terminal) and re-running the app can sometimes sort it out.

Note the deployments will fail if there are any errors, even light ones like "unused variables", if you're using VCS make sure to check the Problems tab and make sure it is empty.

Any questions, ask Yinoguns

---

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.