Simple Next.js Starter

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Examples
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

Light and easy next.js starter for your apps. Client app with React.js with Next.js server with GraphQL, have fun!

(back to top)

Built With

The boilerplate includes:

• Next.js
• Apollo
• React.js
• Typescript
• Material UI

(back to top)

Getting Started

Installation

Install latest LTS Node.js

Clone the repo

git clone https://github.com/fishme/simple-next-boilerplate.git

Install NPM packages

npm install

Run project

 npm run dev

see page http://localhost:3000

Debugger: Build in VSCode Debugger configuration.

Build project

 npm run build

(back to top)

Examples

Some examples inside of the project.

Example	path
GraphQL API	/src/apollo/resolvers.ts
GraphQL API Call	/src/pages/index.tsx
Material UI Theme	/src/theme/theme.ts
SignIn Form	/src/pages/SignIn.tsx

Roadmap

• Docker
• Translation service
• Dynamic Routing incl. SEO urls
• Authentication oauth2
• Tests (Unit, Functional and UI)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Issues: https://github.com/fishme/simple-next-boilerplate/issues
Project Link: https://github.com/fishme/simple-next-boilerplate
Donate: Support the project

LinkedIn: Go in touch with me

(back to top)

Acknowledgments

Nothing to add for the moment.

(back to top)