Code Monkey home page Code Monkey logo

digitaldavis's Introduction

UCD Digital Davis Initiative - Nirvana

UCD_works_12

Project Homepage

Nirvana Lotus logo by Freepik

Prerequisites

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

digitaldavis's People

Contributors

2320sharon avatar botolsen avatar dennisw95 avatar gustavboyd avatar icarus44-zer0 avatar manhsy avatar yang-sacstate avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.