Giter Site home page Giter Site logo

sbeltran10 / my-covid-story Goto Github PK

View Code? Open in Web Editor NEW

This project forked from my-covid-story/www

0.0 1.0 0.0 98.23 MB

We are a group of concerned citizens who could no longer stand by as Ontario is led into a humanitarian crisis. We believe the power of storytelling is an effective means to drive government action.

Home Page: https://www.mycovidstory.ca

License: Creative Commons Zero v1.0 Universal

JavaScript 6.59% CSS 0.96% Shell 0.06% TypeScript 92.39%

my-covid-story's Introduction

My Covid Story

This is an extremely early MVP, so there is a lot to do.

Our stack / architecture is:

  • NextJS hosted on Vercel (already setup here)
  • Prisma as our ORM (makes things pretty smooth)
  • Postgresql as a DB (Digital Ocean, Toronto)

Contributing

  1. Clone this repo
  2. Install dependencies with npm i
  3. Rename .env.template to .env
  4. Get a local postgres db running - Docker is probably easiest, but local postgres would also work
  5. With Docker installed, run docker run --name my-covid-story-dev -p 5432:5432 -e POSTGRES_PASSWORD=mycovidstory -d postgres:12.6-alpine (this will match the DB URL string in .env)
  6. Run npx prisma migrate dev --name init to apply migrations in prisma/migrations.
  7. Run npx prisma db seed --preview-feature to see test data from prisma/seed.ts.
  8. Run npm run dev to start the app locally.
  9. You can use /api/stories to create new stories.
  10. Run npm test to run the test suite. This also gets run automatically on each Pull Request

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, install the dependencies

npm install
# or
yarn install

Then, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.js.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

https://vercel.com?utm_source=my-covid-story&utm_campaign=oss

my-covid-story's People

Contributors

mwickett avatar jamiesonroberts avatar silent1mezzo avatar davesteinberg avatar ryanwelcher avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.