Coffee Chat

Connect Mentors and Mentees by making the process of connecting and then scheduling appointments as easy as possible.

Menu

• Rationale
• Quick Start
• Building
• Installation
• Contributions
  • Commit message standard
• Local development
  • Generate & update typescript types for GQL Schema
  • Run Database migrations
• License
• Code of Conduct
• Security Vulnerability Reporting

Rationale

Quick Start

1. Clone this repository
2. cp .npmrc.sample .npmrc
3. Run npm install
4. cp sample.env .env.
5. cd to local-env, and start the local services docker compose up -d
6. cd .. to the root of this project
7. Run the migrations npx prisma migrate reset
8. Start the development server with npm run dev
9. Navigate to localhost:4444 in your browser to view the React app.

NOTE: the server will be listening in the port corresponding to the PORT variable in .env

Building

Installation

Contributions

We :heart: contributions.

Have you had a good experience with this project? Why not share some love and contribute code, or just let us know about any issues you had with it?

We welcome issue reports here; be sure to choose the proper issue template for your issue, so that we can be sure you're providing the necessary information.

Before sending a Pull Request, please make sure you read our Contribution Guidelines.

Commit message standard

This project aligns to the conventional-commits commit-message standard, and the PR process will enforce this standards. Make sure your PR's commit messages fulfill the standard.

Local development

Generate & update typescript types for GQL Schema

1. Start the server locally

npm run dev

2. Pull the schema into a centralized schema.graphql

Open another terminal window and then run.

npm run gql:update-schema-gql

1. Generate the typescript types for queries

npm run gql:generate-ts-for-queries

Run Database migrations

1. Run a dev migration

npx prisma migrate dev

License

Please read the LICENSE file.

Code of Conduct

This project has adopted a Code of Conduct. If you have any concerns about the Code, or behavior which you have experienced in the project, please contact us at opensource@bloomberg.net.

Security Vulnerability Reporting

If you believe you have identified a security vulnerability in this project, please send email to the project team at opensource@bloomberg.net, detailing the suspected issue and any methods you've found to reproduce it.

Please do NOT open an issue in the GitHub repository, as we'd prefer to keep vulnerability reports private until we've had an opportunity to review and address them.