alexbarksdale/UniLyfe

A platform for verified university students to network, chat, and share their ideas while remaining anonymous.

UniLyfe

Documentation is still in early development

UniLyfe is a platform for verified university students to network, chat, and share their ideas while remaining anonymous. With peace of mind knowing only verified students can register. The goal was to create an environment where students could openly discuss their opinions or ideas.

Table of Contents

• Technologies - Web App
• Technologies - API
• Getting Started
  • Installation - Web App
  • Installation - API

Technologies - Web App

• Typescript
• React
• Redux
• Apollo Client
• GraphQL Codegen

Technologies - API

• Typescript
• Node.js
• Apollo GraphQL
• PostgreSQL
• TypeORM
• JWT

Getting Started

You must install both the web app and UniLyfe API to run this project properly.

Docker documentation coming soon!

Docker

If you are using docker you can get up and running quickly by using docker compose.

1. Navigate to the root directory, you should see a docker-compose.yml file when you run: $ ls
2. Compose the project by running: $ docker-compose up

Installation - Web App

IMPORTANT! The web app depends on the UniLyfe API to run!

This project will be installed with yarn. Please feel free to use any other package manager you prefer.

Prerequisites

1. If you haven't already, install Node.js. You should be able to run the following commands if you installed it properly.

$ node --version
$ npm --version

2. Clone the repository: $ git clone https://github.com/alexbarksdale/UniLyfe.git

3. Register for a Filestack API key. This project utilizes their file handling service to upload images for posts.

4. Navigate to $ cd packages/frontend and rename .env_example to .env and place your key next to REACT_APP_FILESTACK_API_KEY=.

Install

1. Navigate to the web app directory: $ cd packages/frontend

2. Install the necessary packages: $ yarn

3. Start the project: $ yarn start

Installation - API

This project will be installed with yarn. Please feel free to use any other package manager you prefer.

Prerequisites

1. If you haven't already, install Node.js. You should be able to run the following commands if you installed it properly.

$ node --version
$ npm --version

2. Install PostgreSQL.
3. Navigate to the API directory $ cd packages/backend
4. Open ormconfig.json and configure the necessary settings for your database.
5. Rename .env_example to .env and fill out the necessary environment variables.

Install

1. Navigate to the API directory: $ cd packages/backend

2. Install the necessary packages: $ yarn

3. Start the project: $ yarn start

API Documentation coming soon...