Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 3.06 KB

README.md

File metadata and controls

69 lines (48 loc) · 3.06 KB

All Contributors

PostReview

PostReview is a platform for anyone to post their opinions about research papers, post-publication. The app is build via Blitz.js.

Code of Conduct

We welcome anyone who wants to contribute. That said, we ask you to follow our Code of Conduct when you are in our space.

How to Run the App Locally

  1. Clone the repository
  2. Setup the environemnt variables. Note that the app currently uses Google OAuth, which requires a client ID, secret, and callback URL.

Ensure the .env.local file has required environment variables:

DATABASE_URL=postgresql://<YOUR_DB_USERNAME>@localhost:5432/postreview-app
GOOGLE_CLIENT_ID=****
GOOGLE_CLIENT_SECRET=***
GOOGLE_CALLBACK_URL=http://localhost:3000/api/auth/google/callback
ALGOLIA_APP_ID
ALGOLIA_API_SEARCH_KEY
ALGOLIA_API_ADMIN_KEY
ALGOLIA_PREFIX
POSTMARK_TOKEN
UPLOADCARE_PUBLIC_KEY
  1. Run your app in the development mode.
blitz dev
  1. Open http://localhost:3000 with your browser to access the app.

Managing App on Heroku

  • To reset the database, run heroku pg:reset
  • To seed the database, run heroku run blitz db seed

Contributors ✨

Thanks goes to these wonderful people (emoji key):


coglebed
🎨 🐛
Chris Hartgerink
🧑‍🏫 🐛
jazellemaira
💻 🎨

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