This repository contains the second iteration of ResearchEquals that we are developing.
For the in production code (v1), please see libscie/ResearchEquals.com.
The tech stack is based on RedwoodJS (Redwood Documentation).
We want to make it easy for you to get started developing. If you prefer to install everything locally, pick your OS and follow the steps. We are assuming you are starting from scratch.
macOS installation
Ensure you have brew installed before following this guide.
# Install nodejs + npm
brew install nodejs
# Install corepack (required for yarn)
npm install -g corepack
# Enable yarn
corepack enable
# Install dependencies
yarn install
# Install mysql
brew install mysql
# Add local variables
cp .env.example .env
echo "DATABASE_URL=mysql://root:@localhost:3306/dev-db-researchequals" >> .env
# Apply the migrations to your database
yarn rw prisma migrate devLinux installation
To be added - see issue #6.
Windows installation
To be added - see issue #5.
When you have followed the above instructions for your relevant operating system, you can run the following to get started with development:
yarn rw devWe also supply a Docker environment to get up and running. If you are unfamiliar with Docker, you may not want to take this route.
docker compose -f docker-compose.dev.yml up
# Then, connect to the container and migrate your database:
docker compose -f ./docker-compose.dev.yml run --rm -it console /bin/bash
# From within the docker container
yarn rw prisma migrate dev