Finite Loop Club - Official Repo
Built with:
Running the Project
- Clone the repo
git clone https://github.com/FiniteLoop-NMAMIT/flc-website
- Install the dependencies:
npm i
- Create & start a DB on postgres. Run Prisma migrations which will create SQL tables from
schema.prisma
npx prisma migrate dev
- Create an .env file in the root directory and fill the essential vars
DATABASE_URL="..."
GOOGLE_CLIENT_ID="..."
GOOGLE_CLIENT_SECRET="..."
AUTH_SECRET="..."
RAZORPAY_KEY="..."
RAZORPAY_SECRET="..."
- Run the development server:
npm run dev
Open port 3000 on localhost with your browser to see the result.
Additional:
npx prisma studio
to use Prisma Studio(visual editor).
Open port 5555 on localhost with your browser.
Dependencies
"@next-auth/prisma-adapter": "^1.0.4",
"@prisma/client": "^4.2.1",
"axios": "^0.27.2",
"next": "12.2.5",
"next-auth": "^4.10.3",
"next-auth-sanity": "^1.4.4",
"next-themes": "^0.2.1",
"razorpay": "^2.8.3",
"react": "18.2.0",
"react-dom": "18.2.0",
"react-icons": "^4.4.0",
"react-reveal": "^1.2.2",
"shortid": "^2.2.16"
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. While sending the PR please mention the issue in the Comment. Thank you.
Development
First, fork the project and clone it on your local machine. Follow the process given under this section to run and configure the project.
- Create a new branch
git checkout -b branch-name-here
- Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
- Stage & commit the changes, and push them to your fork.
//Staging changes
git add insert-paths-of-changed-files-here
//Commiting changes
git commit -m "Insert a short message of the changes made here"
//Pushing changes
git push origin branch-name-here.
- From your branch that you are working on, give a PR to our
develop
branch. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer.!IMPORTANT
: Don't give a PR to themain
branch, we accept PRs only on develop branch. - Wait for the pull request to be reviewed by a maintainer and make changes to the pull request if the reviewing maintainer recommends them.