Skip to content

Latest commit

 

History

History
93 lines (63 loc) · 2.43 KB

README.md

File metadata and controls

93 lines (63 loc) · 2.43 KB

Contributors

  • Souvik Basu (@souvikbasu)
  • Mohammed Hussam Khatib (@hussamkhatib)
  • Syed Rasheduddin (@SyedRashed007)

Getting Started

To fork the repo

To get the code in your localhost

  • Go to the forked repo in your profile
  • Click Code button and copy the git url from your repo. You may use SSH if you have SSH keys added to settings or use HTTPS
  • If you have not added SSH keys to your GitHub settings, please follow this article
  • Open command prompt and run the following to fetch the code into your local box
    git clone <your git url>
  • Create a reference to the upstream repo to be able to create Pull Requests
git remote add upstream [email protected]:shoonyatech/shoonya.freelance.git

To run the project

  • For the first time install npm packages
cd wallora.com
npm install
  • Run the dev server
npm run dev
  • Run the storybook's explorer
npm run storybook

To use Auth0

  • Use [email protected] to login to auth0 website using google.
  • Copy .env.local.sample to .env.local and populate the fields from the app you see in auth0 post login.
  • After this when you run the dev server and try to login you should be able to see the auth0 login flow.

Reference: https://auth0.com/docs/quickstart/webapp/nextjs

To create a commit and raise a Pull Request (PR)

  • Save your changes and create a local commit
  • commitizen is enabled to mantain a consistent commit format
doc|feat|fix|build(<page name>): <one liner of what is done in present tense>

e.g.

feat(home): add Header component
  • Pull latest from upstream and rebase
git pull upstream main --rebase
  • Resolve any merge conflicts
  • Force push changes to your repo
git push origin main -f
  • Go to your GitHub repo page and click on Create Pull Request button. This will create a PR from your repo to upstream repo
  • One of the project moderators will review and approve your PR. They will ask for any changes if needed