First, make sure you have a working installation of Node.js and NPM.
Now clone the repository and install dependencies:
git clone https://github.com/acmutd/hackportal
cd hackportal
npm install
Next, set up the environment variables.
- Make sure you start your Cloud Storage and Firestore Database in test mode, not production mode if you are setting up for development.
- Make sure you have copied all required environment variables completely and correctly.
- Make sure all environment variables are in double quotes, ex:
MEASUREMENT_ID="1234567890"
By default, this project uses Firebase APIs. If you use any of the following, you must set up Firebase APIs before running this app:
- Firebase Authentication
- Cloud Firestore
- Google Cloud Storage for Firebase
To set up Firebase APIs, first go to the Firebase Console. Make sure to switch to your intended account before continuing.
Now create a Firebase project or use an existing Firebase project.
- If creating a new project, create a new web application and take note of the configuration code provided. Copy that somewhere.
- If using an existing project, navigate to project settings and find the app's Firebase configuration.
Now go back to the HackPortal project files. Rename the .env.template file to
.env.local. This is where the app's environment variables will be set up.
The file should look like this:
NEXT_PUBLIC_FIREBASE_API_KEY=
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=
NEXT_PUBLIC_FIREBASE_PROJECT_ID=
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=
NEXT_PUBLIC_FIREBASE_APP_ID=
MEASUREMENT_ID=
NEXT_PUBLIC_CLOUD_MESSAGING_SERVER_TOKEN=
NEXT_PUBLIC_RESUME_UPLOAD_PASSWORD=
NEXT_PUBLIC_RESUME_UPLOAD_SERVICE_ACCOUNT=
NEXT_PUBLIC_VAPID_KEY=
SERVICE_ACCOUNT_CLIENT_EMAIL=
SERVICE_ACCOUNT_PRIVATE_KEY=
SERVICE_ACCOUNT_PROJECT_ID=
Fill in the corresponding environment variables using the appropriate images from the Firebase Console.
Next, find the cloud messaging server token under the “Cloud Mesaging” tab. It can be found under the project credentials and is named “Server key”. Update the corresponding environment variable.
To generate the vapid key, scroll down to the "Web Configuration" and generate a key pair. Copy the key pair generated and fill in the corresponding environment variable.
Next, set up the service account environment variables.
Navigate to "Service Accounts" under the Project Settings and copy the Firebase service account name. This is the Service Account Client Email.
Next, generate a new private key and download the file. Open the file and copy the Project ID. Update the corresponding environment variable.
In the same JSON file, copy the private key (it should be lengthy) and paste it into the corresponding environment variable.
Next, set up the account to take care of resume uploads.
Navigate to the authentication tab.
Under the “Users” tab, click the button that says “Add user”. Enable sign in with email/password if necessary.
Create a user with an email and password. Copy the email into:
NEXT_PUBLIC_RESUME_UPLOAD_SERVICE_ACCOUNT=
and the password into:
NEXT_PUBLIC_RESUME_UPLOAD_PASSWORD=
Follow the instructions in the Firebase Setup doc to see how to set Firebase up for your hackathon.
Now run the development server:
npm run dev
Open http://localhost:3000 with your browser to see the result.
This project uses a few tools to enforce code quality:
- Prettier, an opinionated code formatter
- Conventional Commits, a format for consistent commit messages
- Commitizen, a tool for easily making formatted commits.
The repository already has these set up. Contributors only need to run
git commit, and Commitizen will take care of the rest with a commit flow. If you find Commitizen to be annoying, feel free to uninstall it.