https://github.com/uriklar/professor

Community driven professor game. Inspired by: https://professor.amiacyb.org/
https://github.com/uriklar/professor

firebase hacktoberfest hacktoberfest2021 nextjs

Last synced: 2 months ago
JSON representation

Community driven professor game. Inspired by: https://professor.amiacyb.org/

• Host: GitHub
• URL: https://github.com/uriklar/professor
• Owner: uriklar
• Created: 2021-04-08T06:45:52.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-10-08T09:28:19.000Z (over 2 years ago)
• Last Synced: 2024-10-17T16:05:18.296Z (3 months ago)
• Topics: firebase, hacktoberfest, hacktoberfest2021, nextjs
• Language: TypeScript
• Homepage:
• Size: 1.07 MB
• Stars: 4
• Watchers: 4
• Forks: 7
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Installation

1. Fork the repo and clone it locally

2. Run 'npm install'

3. To start the server, run `npm run dev`

The repo is a Next.js repo. You can read more about Next.js [here](https://nextjs.org/docs)

## Setting up Firestore

**Note** - if you just want to work on non Database related features, at the bottom of `index.tsx` there's an alternative `getServerSideProps` which will return mock data that is identical to the data from the db.

**If you are just working on FE features i'd suggest using this as it saves a lot of setup**

But, if you need to setup the database :-)

1. Go to https://console.firebase.google.com/ and click **Add project**

2. Click on the **Cloud Firestore** button (it's a big orange sqaure on the page) and click on **Create Database**

3. In the wizard, choose **Production mode**

4. Select a location (preferably eu-something..)

Once your database is created, in the sidebar, next to Project overview, there's a Cog icon. Click it, and navigate to **Project settings -> Service accounts**

1. Click on **Generate new private key**

2. Once the key is generated, you will have a button that downloads a json file

3. In the root of the project, create a file called **serviceAccountKey.json** and paste the content of your downloaded json file. **Note: This file is in the .gitignore, but make sure you don't commit it!**

4. run the app (`npm run dev`)

5. The first run of the app will create an initial board in your firebase DB. You can then comment out the lines in `index.tsx` that have the comment `Seed data` above them. (If they are commented out, you'll need to un-comment them and refresh for the seeding to happen)

## Contributing

See [our open issues](https://github.com/uriklar/professor/issues), and thanks for taking a part in this project!

Join our Slack workspace using [this link](https://join.slack.com/t/professorcrew/shared_invite/zt-p75wib6f-KjlwEii0HoCgXyQXFKiYIw)