This is a MERN app boilerplate repository. You can clone this repo to get a jump start on your next MERN stack project. Built upon create-react-app, it comes pre-loaded with express, mongoose, passport.js and fully functional local user authentication utilizing express-session. Look below for installation and usage instructions.
To use this app first clone the repository to your local machine. To do this, navigate to the directory where you want the project to go and use the command git clone git@github.com:Thenlie/mern-boiler.git.
Next you will need to install the projects npm dependencies. Since all of the required packages are already listed as dependencies in the package.json file this is an easy task. From the root directory of the project simply run the command npm install or npm i.
Once dependencies have been installed you are ready to run the app! This can be done with the command npm run develop from the root directory of the project. You will see a console log stating 'API server running on port 3001!'. This is the address for the backend express server.
Shortly after the console log a browser tab should open at http://localhost:3000. This is the address for you development React app! From here it is up to you to make the application your own!
If you would like to contribute to this project feel free to fork this repo and submit a pull request. You can see more information about pull requests here. Keep in mind this project is meant to be a bare-bones boiler plate so not many features will be added. As new ideas are found I will try and keep an up to date issue for anyone looking to contribute.
MIT License
Copyright (c) [2022] [Type++]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
If you have any questions about the project you can reach out to me via email or GitHub with the information below.
Email: leithen113@gmail.com
GitHub Username: Thenlie