libscie / ResearchEquals.com

Research module server
https://researchequals.com
MIT License
88 stars 10 forks source link

ResearchEquals.com

All Contributors

Discord online

ResearchEquals.com is a research module server, where researchers can publish building blocks of research and link them together in chronological order.

ResearchEquals is deployed on a continuous basis using Flightcontrol and translated on a continuous basis using Weblate.

Code of Conduct

You're welcome to our house in good faith – read our code of conduct for the house rules applicable to all contributions. Good intent does not excuse behavior in violation of these house rules (read more about why here).

Our house may be different from yours, and if you find any of this unagreeable, that's perfectly okay, and we ask you respectfully to not contribute.

Development

Development for this project uses node version 18. Please make sure you are using this version.

Please clone the repository and make sure you have BlitzJS installed:

## Install BlitzJS if you don't have it
npm install -g blitz --legacy-peer-deps

## Clone repository
git clone https://github.com/libscie/researchequals.com
cd researchequals.com

## Install dependencies
npm install

Before you can run a local development version, please ensure you have a Postgres server you can create databases on. Add your preferred route to .env.local as such:

DATABASE_URL=postgres://myuser:mypassword@localhost:5432/researchequals-dev

If you don't have postgres running, you can use the docker-compose file which will set one up:

docker-compose up

To get a fully functional development environment you need to add the environment variables as listed in .env.example. For developing locally, you need to add these variables to two .env files: (1) .env.local and (2) .env.test.local. Please note most of these services are freemium and you can sign up for a free account.

You can migrate and seed your database with

npx prisma migrate dev

blitz db seed

You can start your development environment with

npm run dev

which defaults to localhost:3000.

Submitted pull requests are automatically deployed using Heroku (self-destroyed after 24 hours).

Testing Stripe

If you want to develop the Stripe payment pipeline, you can activate using the following command (after installing the stripe-cli):

stripe listen --forward-to localhost:3000/api/stripe_webhook

Project Structure

All website pages are in /pages, database schemas, migrations, and seeds in /db, translations in /langs, mailer functions in /mailers, public files and images in /public, and tests in /test.

Maintainers :building_construction:

These people spend their time making sure the platform is operational and improves over time. They're always available for messages of appreciation :purple_heart:


Nami Sunami


Chris Hartgerink

Contributors ✨

Thanks goes to these wonderful people (emoji key):

AerynThrace
AerynThrace

πŸ““
AnnaVantVeer
AnnaVantVeer

πŸ€”
Asura Enkhbayar
Asura Enkhbayar

πŸ““
Cassandra Gould van Praag
Cassandra Gould van Praag

πŸ›
Dan Rudmann
Dan Rudmann

πŸ–‹ πŸ§‘β€πŸ« πŸ‘€ πŸ€”
Daniel LombraΓ±a GonzΓ‘lez
Daniel LombraΓ±a GonzΓ‘lez

πŸ““
Daniel NΓΌst
Daniel NΓΌst

πŸ€”
Dependabot
Dependabot

🚧
Egon Willighagen
Egon Willighagen

πŸ““ πŸ’‘ πŸ€” πŸ’»
Esther Plomp
Esther Plomp

πŸ““
Gianluca Della Vedova
Gianluca Della Vedova

πŸ€”
Hanne Oberman
Hanne Oberman

πŸ€”
Jazelle Maira Carillo
Jazelle Maira Carillo

πŸ’»
Jeffrey Spies
Jeffrey Spies

πŸ›
Jessie L Oliver
Jessie L Oliver

️️️️♿️
Kasia
Kasia

🌍
Kaveh Bazargan
Kaveh Bazargan

πŸ›
Mario Angst
Mario Angst

πŸ€”
Marton Kovacs
Marton Kovacs

πŸ““
Mina Abadir
Mina Abadir

πŸš‡
Nami Sunami
Nami Sunami

🌍 🎨 πŸ€” πŸ› πŸ’» πŸ“–
Nathan Sainsbury
Nathan Sainsbury

πŸ›
Nathan Sainsbury
Nathan Sainsbury

πŸ’» 🎨
Patrick Sobrak-Seaton
Patrick Sobrak-Seaton

🎨 ⚠️ πŸ““
Robbie van Aert
Robbie van Aert

πŸ›
Sam Teplitzky
Sam Teplitzky

πŸ““
SarahanneMField
SarahanneMField

πŸ““
Simon
Simon

πŸ›
Solana
Solana

🌍
Stefan Vriend
Stefan Vriend

πŸ›
Thomas F. K. Jorna
Thomas F. K. Jorna

πŸ›
Vinodh Ilangovan
Vinodh Ilangovan

️️️️♿️
Weblate (bot)
Weblate (bot)

🌍
ab-ioi
ab-ioi

πŸ““
coglebed
coglebed

🌍
dvanravenzwaaij
dvanravenzwaaij

πŸ–‹
senficon
senficon

πŸ€”

This project follows the all-contributors specification. Contributions of any kind welcome!