CONTRIBUTING.md

Contributing to Anteater API

Thank you for your interest in contributing to Anteater API!

✅ Getting Started

🛠️ Prerequisites

• For Windows users: A Windows Subsystem for Linux instance
• A Node.js environment
• pnpm, a blazingly fast package manager for Node.js
• nvm, a version manager for Node.js
• Docker Compose for running the local database server
• Optionally: PostgreSQL version 16, for generating database dumps

🧑‍💻 Setting Up

1. Clone the repository and change into it.

   $ git clone [email protected]:icssc/anteater-api.git
   $ cd anteater-api

2. Make a copy of the .env.example.

   $ cp .env.example .env

3. Install the dependencies.

   $ pnpm i

4. Download the latest version of the database dump here, and move it into the packages/db directory.

   Optional: Verify the checksum of the database dump.

   To do this, download the checksum here, move it into the packages/db directory, then run the following command:

   $ sha256sum -c db.sql.gz.sha256sum

   If the checksum does not match, the database dump may be corrupt or have been tampered with. You should delete it immediately and try downloading it again.

5. Start the local Postgres database.

   $ docker-compose up -d

6. Start the development server.

   $ pnpm dev

   The process of database seeding (importing data from the database dump) can take a while. If at first this fails, wait a few minutes before trying again.