Population Management System contains a list of locations and the total number of residents in each location broken down by gender.
The system was built for my D1 ➣ D2 advancement and provides an API that enables you to:
- Create a new location containing data on the total number of male and female residents within it.
- List all available locations and their population summaries (total male residents, total female residents, sum total residents)
- Preview data for a specific locations
- Update data for a specific locations
- Delete a specified location
To setup population_management_system, the following should be installed on your machine.
If you have all the prerequisites you can use the steps below to setup population_management_system locally.
- Open your terminal and
cd
to the directory where you will like to download population_management_system, then run
git clone https://github.com/chukwuemekachm/population_management_system.git
- Change to the population_management_system directory
cd population_management_system
This section assumes your local PostgreSQL installation has a postgres
user without password
- Run the command below to create a database
npm install yarn -g
yarn create:db
- Run the command below to to populate the database
yarn migrate:db
- Run the command below to create a
.env
file from the sample provided
touch .env
cp .env.sample .env
- Now update the environmental variables with the variables you want to use for your population_management_system installation.
- Run the command below to install
node
dependencies
yarn install
- To start up your newly installed population_management_system run
yarn start
- To run the automated tests on your newly installed population_management_system run
yarn test
- Chima Chukwuemeka @chukwuemekachm
This project is licensed under the MIT License - see the LICENSE.md file for details