https://github.com/buildit/meetomatic
https://github.com/buildit/meetomatic
buildit-gravity-consumer distributed meetings realtime-collaboration
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/buildit/meetomatic
- Owner: buildit
- Created: 2019-02-26T11:37:00.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T22:52:00.000Z (over 2 years ago)
- Last Synced: 2025-02-04T23:31:32.329Z (3 months ago)
- Topics: buildit-gravity-consumer, distributed, meetings, realtime-collaboration
- Language: TypeScript
- Size: 4.49 MB
- Stars: 2
- Watchers: 13
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# meetomatic
a simple and necessary tool for distributed meetings, embracing our in-house design system, Gravity.
## Requirements
The Prisma server and database run in docker container so you need to install [Docker](https://docs.docker.com/docker-for-mac/install/)
`gravity-web-ui` requires Node.js version 8 installed. You can either install version 8 and use [nvm](https://github.com/creationix/nvm) to manage your node versions.
$ nvm install
and before running any other npm command, run
$ nvm use
## Build and setup
### Prisma and database
To run the Prisma server and setup the databaes run
$ docker-compose up -d
This will start the prisma and postgres containers.
To deploy the database run
$ cd server/graph-server
$ prisma deploy
Note you only have to run this command when setting up for the first time or if you change the Prisma schema.
This will automatically generate the Prisma .ts files
### Seeding the database with default data
When you first deploy the prisma database it will seed the database with a system user. If you need to re-seed the database run this command from the `graph-server` folder
$ prisma seed
### Resetting the database
To clear all data from the database run
$ prisma reset && prisma seed
### Meet-o-matic server
To run the meet-o-matic service run
$ npm run dev
### API Server GraphQl
At the API server we use [`type-graphql`](https://github.com/19majkel94/type-graphql) to define our graphql schema. This allows us to take advantage of Typescript and write stronly typed resolvers.
When you update the graphql type definition the server will generate a `schema.gql` file which is then used by the client. see below
Follow recommendations laid out in [this article](https://blog.apollographql.com/designing-graphql-mutations-e09de826ed97) when designing your schema.
### Client GraphQl Types
The client uses Apollo client at the front end. It makes use of strongly typed query and mutations by using the apollo codegen functionality
If you write a grahpql query in the client pages run the following command to generate the Typescript types for your query.
$ npm run generate-graphql-types
You can then use the generated types to strongly type your Query and Mutations
```javascript
const LOGIN_USER = gql`
mutation Login($email: String!, $password: String!) {
login(input: { email: $email, password: $password }) {
token
user {
name
id
email
}
}
}
`;
class LoginMutation extends Mutation {}
```
Then use it:
```javascript
{function(loginUser, { loading, error }) {
return (
loginUser({ variables: { email, password } })
}
/>
);
}}
```
TODO:
- Document service
- How to write and run tests
- How to debug
## Managing the docker containers
To stop the docker containers run
$ dcoker-compose down
To list all containers run
$ docker container ls -a
To delete the containers run
$ docker container rm
or to delete all stoped containers run
$ docker container prune
The database files are mapped to a docker volume on your local disk so they persist between container restarts.
To delete the volume and reset all database data run
$ docker volume rm meetomatic_postgres