Skip to content

cramkle/hipocampo

Repository files navigation

Hipocampo

CI

Hipocampo is the GraphQL API for the Cramkle project.

Getting started

To setup this project, run the following commands:

git clone https://github.com/cramkle/hipocampo
cd hipocampo

# Install dependencies
npm install

# Copy example env file to .env
cp .env.example .env

This project also depends on MongoDB (for persistent storage) and Redis (for session storage), so you will need to install those as well. If you use Homebrew, you can run the following commands to install them:

brew update
brew tap mongodb/brew
brew install mongodb-community redis

Development

Now that you've setup all the project dependencies, you can start developing by running:

npm run dev

This will start the API on http://localhost:5000/. You can access GraphiQL by accessing the /graphql route.