SocietyClub / RCV

Ranked Choice Voting application
https://www.rankedchoice.info/
2 stars 0 forks source link

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

Getting Started

Via vercel Only applicable if you have access to the vercel project.

If you're on windows make sure to lowercase the RCV project name.

# Install vercel globally
yarn global add vercel
# Install project packages
yarn install
# Link to the vercel societclub/rcv project
vercel link
# Run vercel with the environment variables via vercel or pull them and run manually
vercel dev
or
vercel env pull
yarn run dev

Via yarn

TODO: create instructions on how to run without needing a firestore account (using the test environment)

Copy .env.example to .env then fill the firestore credentials from your own google account

yarn dev
# or
npm run dev

Development instructions

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

You can start editing the page by modifying pages/index.tsx. 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.ts.

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

Deployment

For testing, every PR will create a vercel preview deployment which you can use to test your changes.

For production deployment, simply get your PR merged into the main branch.

Learn More about Next.js