Contributing - Advanced

Prerequisites
Building and Running Monkeytype
Standards and Guidelines
Questions

Prerequisites

This contribution guide is for cases in which you need to test the functionality of your changes, or if you need to take screenshots of your changes. You will need a computer with a stable internet connection, a text editor, Git, and NodeJS with version 16.13.2. There are some additional requirements depending on what you're looking to contribute, such as Firebase for authentication, Mongo and Docker for the backend. Read the below sections to understand how to set up each of these tools.

Git

Git is optional but we recommend you utilize it. Monkeytype uses the Git source control management (SCM) system for its version control. Assuming you don't have experience typing commands in the command line, we suggest installing Sourcetree. You will be able to utilize the power of Git without needing to remember any cryptic commands. Using a Git client such as Sourcetree won't give you access to the full functionality of Git, but provides an easy to understand graphical user interface (GUI). Once you have downloaded Sourcetree, run the installer. While installing Sourcetree, keep your eyes peeled for the option to also install Git with Sourcetree. This is the option you will need to look for in order to install Git. Make sure to click yes in the installer to install Git with Sourcetree.

NodeJS and NPM

To install NodeJS, navigate to the NodeJS website and download the 16.13.2 LTS.

Alternatively, if you use nvm then you can run nvm install and nvm use (you might need to specify the exact version) to use the version of Node.js in the .nvmrc file (if you use Windows, use nvm-windows).

Docker (Recommended but Optional)

You can use docker to run the frontend development environment. This will take care of OS specific problems. After installing Docker run the following command to start the frontend server:

cd frontend && docker-compose up

Once wepback has compiled, the frontend will be served on port 3000

Firebase (optional)

If you want to use the authentication system locally you need to follow this step. Otherwise, just duplicate firebase-config-example.ts and rename it to firebase-config.ts.

Create a Firebase account if you already haven't done so.
Create a new Firebase project.
- The project name doesn't matter, but the name monkeytype would be preferred.
- Google Analytics is not necessary.
Run npm install -g firebase-tools to install the Firebase Command Line Interface.
Run firebase login on your terminal to log in to the same google account you just used to create the project.
Git clone this project.
- IMPORTANT: If you are on Windows, run git config --global core.autocrlf false before-hand to prevent CRLF errors.
Within the frontend directory, duplicate .firebaserc_example, rename the new file to .firebaserc and change the project name of default to the firebase project id you just created.
- If .firebaserc_example does not exist after cloning, create your own with:
```
 {
     "projects": {
         "default": "your-firebase-project-id"
     }
 }
```
- Run firebase projects:list to find your firebase project id.
Within the frontend/src/ts/constants directory, duplicate firebase-config-example.ts, rename it to firebase-config.ts and paste in your firebase config object
- To find it, go to the Firebase console
- Navigate to Project Settings > General > Your apps
  - If there are no apps in your project, create a new web app
- In the SDK setup and configuration section, select npm
- The Firebase config will be visible below
Enable Firebase Authentication (optional)
- In the Firebase console, go to Authentication > Sign-in method
- Click on Email/Password, enable it, and save
- Click on Google, add a support email and save
Generate a Firebase Admin private key (optional, only needed if you want to work on the backend)
- In your Firebase console, go to Project Settings > Service Accounts
- Click "Generate New Private Key"
- Save as serviceAccountKey.json inside the backend/src/credentials/ directory.

Backend (optional)

Follow these steps if you want to work on anything involving the database/account system. Otherwise, you can skip this section.

Inside the backend folder, copy example.env to .env in the same directory.
Setup the database server

Local Server	Docker (recommended)
Install MongoDB Community Edition Make sure it is running	Install Docker on your machine Run `docker-compose up` from the `./backend` directory

(Optional) Install MongoDB-compass. This tool can be used to see and manipulate your data visually.
1. To connect, type mongodb://localhost:27017 in the connection string box and press connect. The monkeytype database will be created and shown after the server is started.

Building and Running Monkeytype

Once you have completed the above steps, you are ready to build and run Monkeytype.

Run npm run install-all in the project root to install all dependencies.
- If you are on Windows, use npm run install-windows.
- If neither works, you will have to run npm install in root, frontend, and backend directories.
Run npm run dev (npm run dev-fe if you skipped the Backend section) to start a local dev server on port 3000. It will watch for changes and rebuild when you edit files in src/ or public/ directories. Note that rebuilding doesn't happen instantaneously so be patient for changes to appear. Use Ctrl+C to kill it.

Standards and Guidelines

Code style is enforced by Prettier, which automatically runs every time you make a commit (git commit) (if you've followed the above instructions properly).

We recommend following the guidelines below to increase your chances of getting your change accepted.

Questions

If you have any questions, comments, concerns, or problems let me know on GitHub, Discord in the #development channel, or ask a question on Monkeytype's GitHub discussions and a contributor will be happy to assist you.

7.7 KiB Raw Blame History