An awesome NextJS template to jumpstart your projects!
Report Bug
·
Request Feature
Table of Contents
There are many great NextJS templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a NextJS template so amazing that it'll be the last one you ever need.
Here's why:
- Your time should be focused on creating something amazing. A project that solves a problem and helps others
- You shouldn't be doing the same tasks over and over like creating the foundation of your projects from scratch
- You should implement DRY principles to the rest of your life 😄
Of course, no one template will serve all projects since your needs may be different. So I'll try to update it in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!
To get a local copy up and running follow these simple example steps.
Make sure to have NodeJS on your machine and it's up to date, you can do so with the following.
-
NPM
npm install npm@latest -g
-
Clone the repo
git clone https://github.com/WildCodeSchool/2023-11-wns-bleu-g4
Below is a step by step series of tasks that will help you on installing and setting up your app
-
Start the project in 1 command
## At the root npm run dev
This will install and run the backend, database, upload and the frontend modules all at once with docker.
OR
-
Install NPM packages
## For the frontend cd frontend npm install ## For the backend cd backend npm install ## For the upload cd upload npm install ## For the tests cd e2e-tests npm install
-
Or start the back & front only
## For the frontend cd frontend npm run dev ## For the backend cd backend npm start
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/YourFeatureName
) - Commit your Changes (
git commit -m 'Add some YourFeature'
) - Push to the Branch (
git push origin feature/YourFeatureName
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt
for more information.