Skip to content

Latest commit

 

History

History
78 lines (53 loc) · 2.63 KB

readme.md

File metadata and controls

78 lines (53 loc) · 2.63 KB

BDIRS (BDIRS BACHELOR DEGREE INFORMATION AND RECOMMENDATION SYSTEM)

React Native is released under the MIT license. Current npm package version. PRs welcome!

Background

This platform helps to address an issue with applying and getting the right degree program to to at university more so public universities in Uganda. Choosing the right program to do at university can help one get their dream job as well do something they love.

Project dependencies
  • Javascript/Typescript Full Stack
  • Node JS Backend
  • Express Js Framework
  • Jest Testing Framework
  • Postgres Database
  • Sequelize
Setup

  • clone repo using git clone https://github.com/bdirs/bdirs-authentication.git

  • cd into project using cd bdirs-authentication.

  • install dependencies using yarn yarn or npm install

  • create a .env file and copy content from env-example.txt

  • populate .env file with appropiate values

  • Run migrations using yarn db:migrate

  • Run seeders using ./node_modules/.bin/sequelize db:seed:all

  • start dev server using yarn start:dev

  • Run tests using yarn test

Docker Setup

  • Run docker-compose up -d

  • Run migration using docker-compose exec api yarn db:migrate

  • Run docker-compose exec api export SUPER_ADMIN_EMAIL=anyemail to add super admin email

  • Run docker-compose exec api export SUPER_ADMIN_PASSWORD=password to add super admin password

  • Run Seeders using docker-compose exec api ./node_modules/.bin/sequelize db:seed:all

NOTE

Please find the full project report attached to repo. Some diagrams got mixed up but will be fixed soon