Skip to content

practical-works/express-sample

Repository files navigation

🌏 Express Sample

Web JavaScript NodeJS

ExpressJS sample project featuring useful libraries.

🌐 View Live Demo

Screenshot

πŸ“œ 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
  1. Install the dependencies:
npm i
  1. Install Nodemon globally:
npm i -g nodemon
  1. 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
  1. Start server for production:
npm start

πŸš€ Development

🏭 Environment

πŸŒ‘ Backend

πŸŒ• Frontend

πŸ“ƒ License

Licensed under MIT.