Getting started with your next project can be tricky and time consuming. The objective of this Starter App is to reduce the time and effort it takes to set up a base application for your next project. I'd like to call it a "Micro Framework"
.
- Local authentication - Authenticate users statelessly using JSON Web Tokens (JWT)
- Social authentication - Authenticate users via Facebook, Twitter or Google with Passport.js
- Password recovery / reset
- Database models - Pre-built Mongoose schema, easy to extend. Read more about Mongoose
- Emails - Templated e-mails with MailGun API service support
- Heroku-ready - Ready to be deployed to Heroku
1. Install Node.js to your computer
2. Clone the starter app to your desktop using clone
command:
git clone https://github.com/BCooperA/mean-skeleton.git
3. Download and install MongoDB to your desktop
4. After installing MongoDB, create a new database (TEST_DB)
for our application
> use YOUR_DATABASE_NAME
5. Create a .env
file from .env.example
and add environment variables
6. Install required dependencies for the application
npm install
7. Run application
node server
.env.example
- Sample file for applications environment variablesGulpfile.js
- For automating painful or time-consuming tasks in your development workflowProcfile
- Specifies the commands that are executed by the app’s dynos in Herokuserver.js
- Entrypoint for running and binding API
app/
- Frontend of the application, developed with AngularJSconfig/
- Configuration filesmiddleware/
- Application middleware filesmodels/
- Schema files, buit with Mongoosepublic/
- Static files (img, js, css)routes/
- Route files for the application