-
node
-
npm
-
clone the project folder.
-
open the terminal and write
cd Github-Repo-Finder
. -
install server dependancies by
npm install
. -
install client dependancies by
cd client
thennpm install
.
-
back to project directory by
cd ..
. -
write
npm run dev
to run both server and client.
Using the endpoints in the following table
Http verb | Endpoint | Description |
---|---|---|
GET | /api/repos/search/?q=searchquery |
endpoint to seach for repository. |
GET | /api/bookmarks/list |
endpoint to return us a list of bookmarked repositories. |
GET | /api/bookmarks/bookmark/:repository_id |
add a repository by its id to bookmark list. |
GET | /api/bookmarks/remove/?id=repository_id |
to delete the bookmark of a repository by its id |
POST | /api/users/register |
register new user with name, username, password |
POST | /api/users/login |
user login with username, password |