Skip to content

koechkevin/express-template

This branch is 1 commit ahead of master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

de2e32d · Sep 21, 2021

History

2 Commits
Jul 13, 2019
Jul 13, 2019
Jul 13, 2019
Jul 13, 2019
Jul 13, 2019
Jul 13, 2019
Jul 13, 2019
Jul 13, 2019
Jul 13, 2019
Jul 13, 2019
Sep 21, 2021

Repository files navigation

express-template

Setup

  • Libraries, tools and Frameworks

    • Node js - Javascript runtime environment
    • Express js - A Javascript web applications framework.
    • Babel 7 - A Javascript transpiler that transforms the latest versions to browser compatible versions.
  • Clone the repository - $ git clone https://github.com/koechkevin/population-management-sytem.git

  • Change into the project directory - $ cd population-management-sytem

  • Install the dependencies - $ yarn install

    • Please provide the following environment variables
        DATABASE_HOST - your database host name
        DATABASE_NAME - The name of your database
        DATABASE_PASSWORD - password
        DATABASE_USER - your username on the database
        TEST_DATABASE - This a database name you will run the tests against
        PORT - the port number your application will run on. This defaults to 3000 if its not provided
    

    Production

    • Transpile the code and bundle by running $ yarn build
    • Run the server $ yarn start

    Development

    • Start the api with $ yarn start:dev. This uses the default port you provided on environment variables
    • Run any available migrations - $ yarn migrate

    Testing

    • Run the tests using $ yarn test

About

This is an express api template

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published