Running HelpR Locally
Getting HelpR up and running locally is pretty easy!
First, clone/fork the repo (opens in a new tab) and install the dependencies:
$ git clone https://github.com/tamuhack-org/helpr.git $ cd helpr $ npm i
Then, create a
.env file in the root of the project and add the following:
NEXT_URL= NEXTAUTH_SECRET= GOOGLE_CLIENT_ID= GOOGLE_CLIENT_SECRET= DATABASE_PRISMA_URL=
See more information about these variables below.
Finally, run the development server:
$ npm run dev
Obtained by using the URL of the locally hosted site,
/api/auth. Learn more from the NextAuth Docs. (opens in a new tab)
A random string used to hash tokens, sign/encrypt cookies and generate cryptographic keys. Learn more from the NextAuth Docs. (opens in a new tab)
Generate with openssl in the terminal:
$ openssl rand -base64 32
Follow these steps to obtain this information:
- Create a new Google Cloud Project.
- Create credentials for a new OAuth 2.0 Client ID.
- Set the Application Type as Web Application and choose any name.
http://localhost:3000/api/auth/callback/googleas an Authorized redirect URI.
- Save the configuration. Once created, you can view the Client ID and Client Secret.
localhost:3000 with the canonical URL of the deployment.
Follow the above steps 👆
The PostgreSQL database URL. A PostgreSQL database can be hosted on many platforms, including Heroku, AWS, and Vercel. We recommend Vercel because it's free and easy to set up.