aichholzer / ExpressBoilerplate

🤖 An Express application ready to use, and extend, in seconds!

 

An Express application ready to use -and extend- in seconds!

This is a basic setup and it's intended for making the initial application architecture process much faster and easier.

Setup

1. Make you have access to MongoDB (local or remote, does not matter),
2. clone this repository,
3. install what's needed: npm i,
4. copy .env.sample to .env (change the values, if needed),
5. build the static assets (these are located in /source): npm run build,
6. run the application: npm start

Note: Building the static assets will, by dedault, yield a boilerplate.css.min and a boilerplate.js.min file (in their respective folders). However, you can change the name of the output file by passing the name to the build command; npm run build -- -out=... -where out will be the name of the output files. (Also, remember to change the file name in the views where these static assets are being used.)

Done

Visit http://localhost:9000 (Unless you changed the port in your .env file)

Practice

• Take a look at /app/core/controllers/cities.js and /app/core/controllers/users.js, they both implement some basic CRUD logic.
• Create forms in their respective views (/app/core/views/) that allow you to create users and cities.
• Implement delete methods for both entities.
• Submit a pull request (Describe what you did and why you did it.)

Happy learning.

Contribute

fork https://github.com/aichholzer/ExpressBoilerplate/

License

MIT