Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arjunchib/memebot-api-v2

The API for interacting with the MemeBot Database
https://github.com/arjunchib/memebot-api-v2

Last synced: about 2 months ago
JSON representation

The API for interacting with the MemeBot Database

Awesome Lists containing this project

README

        

# Memebot API

The API for interacting with the MemeBot Database

## Getting Started

1. Install node via [nvm](https://github.com/nvm-sh/nvm#installation-and-update)
or some other method (the node version for this project can be found in
`.nvmrc`)

2. Install [yarn](https://yarnpkg.com/en/docs/install)

3. Install dependencies with `yarn install`

4. Install
[MongoDB Community Edition](https://docs.mongodb.com/manual/installation/#mongodb-community-edition-installation-tutorials)

5. Run `mongod` via the instructions from the previous step's install page

6. Set the environment file up according to the example

7. Seed the database by running `yarn seed`

8. Start the graphql server by running `yarn develop`

## Code Formatting

If you would like to contribute to the project, setup linters and style checkers
according to the
[code formatting wiki entry](https://github.com/arjunchib/memebot-api/wiki/Code-Formatting)