- Node.js (v14 or higher)
- Python (v3 or higher)
- Clone the repository
https://github.com/lidasusansabu13/SE577-Project.git
- Navigate to the cloned repo using the command
cd SE577-Project
- Type the command
git pull
to get all latest updates. - Type the command
git checkout proj-Release-3
to switch toproj-Release-3
branch - If you run the
ls
command you can see the folder structure:
├── Server
│
├── client
│
├── GitManagerArchitecture.jpg
│
└── Readme.md
-
Make sure you have Python 3.x installed you can use these commanda
$ sudo apt-get update $ sudo apt-get install python3.6
-
You can make use of a virtual envirnment to avoid installation issues
python3 -m venv se577venv
and activate it by using the commandsource bin/activate
after moving to the directory usingcd se577venv
after thatcd ..
-
Navigate to the
Server
directory and runpip install -r requirements.txt
to install the necessary dependencies for the backend -
Create a
.env
file and copy paste the appropriate envirnment variables example :GH_ACCESS_TOKEN=your_github_access_token GH_API_URL=https://api.github.com/
-
Open a terminal and run
python app.py
orpython3 app.py
to start backend server -
To check if the server is running open your web browser and navigate to
http://localhost:8080/
to see the message 'Server is working....' -
Open your web browser and navigate to
http://localhost:8080/repositories
to get all repositories data -
Navigate to the
client
directory in a seperate terminal and runyarn
to install the necessary dependencies for the frontend -
run
yarn dev
to start the frontend development server and it will open inhttp://localhost:5173/
-
navigate to
http://localhost:5173/projects
to see the list of repositories.
- Feature 1: Under
/repositories
page, to get all repositories data
http://localhost:8080/repositories
: Get all repositories data.
- Vue.js
- Python Flask