Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 1.31 KB

README.md

File metadata and controls

46 lines (27 loc) · 1.31 KB

Express.js Boilerplate

This repository a collection of starter code, curated by yours truly. It's designed to help you kickstart your projects with a solid foundation. Whether you're building a web application, a mobile app, or a backend service, this repository has got you covered.

replace the word boilerplate with your project name and happy coding, Enjoy!

Boilerplate Core Server

This is a core server for Boilerplate

Steps to start development

Install all the dependencies

npm install or yarn

Verify .env.development files with following values

PORT=3000 HOST=localhost:3000

Run the development server

npm run dev or yarn dev

Run Test Suite

npm run test or yarn test

Project Structure

The layout of the project is:

  • src/: This directory contains all of the project's source code.
  • tests/: This directory contains tests for the project.
  • .env.development: This file contains environment variables for the development environment.

Contributing

When you are contributing to this project, please follow these steps:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a pull request