README.md

UCD Digital Davis Initiative - Nirvana

Project Homepage

Nirvana

Prerequisites

• MongoDB ^5.0
• Node ^14.17.6
• NPM ^6.14.15
• WSL 2
• Ubuntu ^18.04.6 LTS
• Docker ^20.10.8
• Docker Compose ^3.8

Installing Dependencies with NPM

1. From /app/frontend/
2. npm install
3. From /app/api/
4. npm install

Updating .env vars

1. Add new .env file to /app/api/
2. Inside of /app/api/config/ add .env via dotenv package

Building the Frontend with Expo

1. From the /app/frontend dir
2. npm start

Deploy Locally with Docker Compose

1. docker network create --subnet 172.23.0.0/16 dev_network
2. docker-compose -f docker-compose.dev.yml --project-name final_iteration --env-file ./api/.env up --no-deps --build -d --remove-orphans mongo-database
3. docker-compose -f docker-compose.dev.yml --project-name final_iteration --env-file ./api/.env up --no-deps --build --remove-orphans express-api

Deploy to Container Registry with Docker Compose

1. Select Production docker compose file
2. docker-compose -f docker-compose.prod.yml --project-name final_iteration --env-file ./api/.env up --no-deps --build --remove-orphans express-api
3. Follow the steps from you cloud provider to push an image to a container registry

Running Tests with JEST

1. Database must be started
2. From /app/api/
3. npm run test

Package Structure

└───app
    ├───.expo-shared
    ├───frontend
    │   ├───.expo
    │   ├───.expo-shared
    │   ├───assets
    │   └───src
    │       ├───axios
    │       ├───navigators
    │       ├───screens
    │       │   ├───challengesScreen
    │       │   │   └───components
    │       │   │       └───banners
    │       │   ├───formularyScreen
    │       │   ├───insightsScreen
    │       │   ├───knowledgeScreen
    │       │   ├───Profile
    │       │   │   └───components
    │       │   ├───searchScreen
    │       │   └───userScreen
    │       └───sharedComponent
    ├───api
    │   ├───certificates
    │   ├───config
    │   ├───controllers
    │   ├───middleware
    │   ├───models
    │   │   └───plugins
    │   ├───public
    │   ├───routes
    │   ├───services
    │   ├───tests
    │   │   ├───fixtures
    │   │   ├───integration
    │   │   └───utils
    │   │       └───models
    │   ├───utils
    │   └───validate
    └───database

Developers

Final Iteration - California State University, Sacramento - CS Senior Project Team

1. Akasha Stallworth: Github - LinkedIn
2. Daniel Olsen: Github - LinkedIn
3. Dennis Worley Jr.: Github - LinkedIn
4. Gustav Boyd: Github - LinkedIn
5. Joshua Poe: Github - LinkedIn
6. Manh Sy: Github - LinkedIn
7. Sahira Rizvi: Github - LinkedIn
8. Sharon Fitzpatrick: Github - LinkedIn

API

Forked from hagopj13/node-express-boilerplate

Known Issues

1. Frontend cannot be built with expo in a emulated environment - Requires Native CLI