Skip to content

ashfaqhaq/curate-frontend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Curate Roadmaps 🚀

Curate-Frontend licence styler forks styler stars styler issues styler pull-requests

View Demo · Report Bug · Request Feature

Introducing Curate Roadmaps 🚀

Curate Roadmaps

Read blog 📖

🚀 Demo

https://curate-roadmaps.netlify.app

Backend API documentation: https://nest-js-curate.herokuapp.com/api/

😎 Features

  • User Authentication
  • Curate roadmaps for everyone
  • 🌈 Share your favorite resources list

🛠️ Installation Steps

  1. Fork this repository
  2. Clone your forked copy of the project.
git clone --depth 1 https://github.com/<your username>/curate-frontend.git

To test if it is working properly change the following variables in index.js

Important configuration

 <Auth0Provider
    domain= <AUTH0_dev>
    clientId= <AUTH0_clientId>
    redirectUri={window.location.origin} // dont change
    audience= <AUTH0_audience>
    scope="openid profile email"
  >

After doing these, go to Auth0 dashboard to change the callback, logout and web origins to localhost:3000 (which is currently where you will be signing in)!

  1. Change the working directory
cd curate-frontend
  1. Add a reference to the original repository.
git remote add upstream https://github.com/ashfaqhaq/curate-frontend.git
  1. Check the remotes for this repository.
git remote -v
  1. Always take a pull from the upstream repository to your main branch to keep it at par with the main project(updated repository).
git pull upstream main
  1. Create a new branch.
git checkout -b <your_branch_name>

You are all set! Open localhost:3000 to see the app. (Authenticated via Auth0)

  1. Track your changes
git add .
  1. Commit your changes .
git commit -m "Relevant message"
  1. Push the committed changes in your feature branch to your remote repo.
git push -u origin <your_branch_name>

  1. To create a pull request, click on compare and pull requests. Please ensure you compare your feature branch to the desired branch of the repo you are suppose to make a PR to.

💻 Built with

  • Auth0: User Authentication
  • Frontend : React
  • Backend : Nestjs
  • Chakra UI-React: Rich Styling
  • Rough Notation: A javaScript library to animate annotations on a web page
  • Heroku: For Server
  • Netlify: For Frontend

🚀 Future Plans

  • Individual Profile pages detailing the complete history and resources.
  • Sorting out Rodmaps according to beginners, intermediate and advanced levels.
  • Enable collaboration medium by creating communitiy and creating forums.
  • Toggle Custom themes.

🛴 Deploy

Netlify Status


✌ Connect with me on Twitter