Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mikescops/expressjs-starter-kit
🌀 ExpressJS + MongoDB + Nunjucks starter kit to kickstart your projects
https://github.com/mikescops/expressjs-starter-kit
expressjs mongodb nodejs nunjucks starter-kit
Last synced: about 2 months ago
JSON representation
🌀 ExpressJS + MongoDB + Nunjucks starter kit to kickstart your projects
- Host: GitHub
- URL: https://github.com/mikescops/expressjs-starter-kit
- Owner: Mikescops
- Created: 2018-10-29T09:02:24.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-29T10:02:19.000Z (9 months ago)
- Last Synced: 2024-05-02T04:14:08.261Z (8 months ago)
- Topics: expressjs, mongodb, nodejs, nunjucks, starter-kit
- Language: HTML
- Homepage:
- Size: 185 KB
- Stars: 1
- Watchers: 3
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ExpressJS Starter Kit
[](https://codeclimate.com/github/Mikescops/expressjs-starter-kit/maintainability)
This project suggest a MVC (model - view - controller) architecture for an ExpressJS project.
It uses MongoDB to store data as well as Nunjucks for templating.
## Project structure
```
|-- app.js (main script to start the app)
|-- package.json (metadata and dependencies)
|-- models
|-- db.js (to connect to database)
|-- users.js (define users contenttype)
|-- routes
|-- index.js (define route to homepage)
|-- users.js (define routes to users pages)
|-- controllers
|-- index.js (handle response for homepage)
|-- users.js (handle response for users contenttype)
|-- views
|-- users (templates for users contenttype)
|-- partials (templates called with 'include')
|-- layout (templates called with 'extends')
|-- something.html (any template used by Nunjucks)
|-- ...
|-- public
|-- assets (any css, js or img that need to be publicly accessible)
```
## Installation
You must have **NodeJS and MongoDB** installed on your system, verify with :
`node --version && mongo --version`
Alternatively, you can run MongoDB via a Docker image (much easier!), just run :
`docker run --name mongo-express-project -p 27017:27017 -d mongo:latest`
Go into root folder and enter the following line in your terminal :
`npm ci` to install node dependencies (`ci` will follow the exact packages versions declared in `package-lock.json`).
## Launch project
Start the project with :
`npm run start`
## Launch project (docker version)
If you want to launch the project inside a container with the associated Mongo database, you can run:
`docker-compose up`
## About design
The administrative panel template is from [Ad.min](https://github.com/Mikescops/ad.min) which is a minimal admin template.
## Various documentation
- ExpressJS : https://expressjs.com/en/starter/hello-world.html
- Mongoose (mongodb object modeling for nodejs) : https://mongoosejs.com/docs/
- Nunjucks (mozilla templating for nodejs) : https://mozilla.github.io/nunjucks/templating.html
- FontAwesome (icons font) : https://fontawesome.com/icons
- Kacole2's skeleton (inspiration of this project) : https://git.io/fxQXK
## Contributing
Feel free to contribute to this project, fork and pull request your ideas.
Don't include work that is not open source or not from you.
## Authors
| [](http://twitter.com/mikescops 'Follow @mikescops on Twitter') |
| ----------------------------------------------------------------------------------------------------------------------------------------------- |
| [Corentin Mors](https://pixelswap.fr/) |