practical-works/express-sample

🌏 ExpressJS sample project featuring useful libraries.

🌏 Express Sample

ExpressJS sample project featuring useful libraries.

🌐 View Live Demo

📜 Introduction

This is a simple mock backend based Website project built with ExpressJS. It is setup with some common NodeJS libraries. This project can be used for learning purposes or as a starter template for starting a project.

🏁 Getting started

1. Clone the repository:

cd somewhere
git clone https://github.com/practical-works/express-sample.git
cd express-sample

2. Install the dependencies:

npm i

3. Install Nodemon globally:

npm i -g nodemon

4. Run server for development:

npm run dev

✈️ Deployment

💡 It is advised to not push the .env file in production. either delete it or add it to .gitignore.

To deploy the project in a node environment:

1. Push the repository to a node server using a service like Heroku.

2. Install the dependencies:

npm i

3. Start server for production:

npm start

🚀 Development

🏭 Environment

• Runtime: NodeJS
• Package Manager: NPM
• Editor: Sublime Text

🌑 Backend

• ⚛️ Core:
  • Main: NodeJS / ExpressJS
  • Template Engine: EJS
• 🔧 Utils:
  • Validation: Express-Validator
  • Session Storage: Cookie-Session
  • Environment Configuration: DotEnv
  • Console Logging: Morgan
  • Console Coloration: Colors.JS
  • Hot Reloading: LiveReload / Connect-LiveReload

🌕 Frontend

• 🎨 UI: Bulma

📃 License

Licensed under MIT.