https://github.com/uoa-cs732-se750-students-2022/project-group-xerothermic-xeruses

Flocker - Find a time for you and your group
https://github.com/uoa-cs732-se750-students-2022/project-group-xerothermic-xeruses

apollo graphql jest nestjs react typescript

Last synced: about 1 month ago
JSON representation

Flocker - Find a time for you and your group

• Host: GitHub
• URL: https://github.com/uoa-cs732-se750-students-2022/project-group-xerothermic-xeruses
• Owner: UOA-CS732-SE750-Students-2022
• Created: 2022-03-11T00:40:21.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-05-27T01:22:20.000Z (over 2 years ago)
• Last Synced: 2024-06-11T19:16:21.586Z (7 months ago)
• Topics: apollo, graphql, jest, nestjs, react, typescript
• Language: TypeScript
• Homepage: https://flocker.us
• Size: 9.03 MB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Flocker

Flocker is a meeting management app. It allows users to create meetings and view the availability of other users to view the best time to schedule a meeting.

Create an account, flocks (meetings), invite other users to join your flock and view the best times to hold your meetings. Includes integration with Google Calendar and allows for ical uploads so your calendars can be used to automatically mark your availability. 

Flocker can be accessed at [flocker.us](https://flocker.us/).

![image](https://user-images.githubusercontent.com/62322685/168505929-a932163c-c8a3-4600-8327-a2a8eece9c28.png)

# Project Information

## Tech Stack 

[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)

This project uses Lerna for monorepo management. With this, you are able to run the front and backend

in parallel with one command, or in isolation.

### Backend

- TypeScript

- GraphQL 

- NestJS

- Firebase Auth

- Mongoose

- MongoDB

- Mongo Memory DB

- Jest 

### Frontend

- TypeScript

- React

- Apollo GraphQL client

- MUI

- FirebaseUI for auth

- React Testing Library

- Jest

## Running Locally

To run the front and backend simultaneously, follow the steps below. 

To run or test the front and backend in isolation, consult the relevant READMEs.

### Setup

1. Install packages

   `npm install`

   

2. Build packages

   `npm run build`

### How to run

1. Run

   `npm start`

2. Test

   `npm test`

## Documentation

All features/improvements were recorded through GitHub Issues and managed using the Flocker project board. Any change to the existing code was reviewed by at least one other team member via pull requests. 

Meeting minutes can be found in the Wiki.

# Contributors

Backend

- Matt Moran

- Maggie Pedersen

Frontend

- Beverley Sun

- Yuwei Shen