/readme-template

ReadMe Template

MIT LicenseMIT

Logo

ReadMe Template

This is a blank README template for common GitHub repositiories.

View Demo | Report Issue | Request Feature | @webceyhan


Requirements

You need to install the Node.js and npm package manager first.

Recommended IDE: VSCode


Installation

  1. Clone the repository. 
    git clone https://github.com/webceyhan/project-name.git
  2. Get inside the cloned project folder. 
    cd project-name
  3. Install NPM packages. 
    npm install

Usage

You can use following commands to do various task with the project.

npm start           # run application
npm run dev         # start development server
npm run test        # run test suits
npm run build       # build for production
npm run deploy      # deploy to production server

Take a look at the other scripts in package.json


Development

Start the development server to watch changes while you code.

npm run dev

Testing

Run the test suits to get a coverage report.

npm run test

Building

Build the application for production.

npm run build

Deployment

Deploy the application to the production server.

npm run deploy

Roadmap

  • Update packages
  • Merge and close pull-requests
  • Create new release

References