Skip to content

– Building a web-based, cloud-native, front end to GitHub that contains a dashboard that provides an overview of the repositories, issues, pull requests, and other activities for a specific user or organization. – Single-page application designed using Vue.js (JavaScript, HTML and CSS)

Notifications You must be signed in to change notification settings

lidasusansabu13/GitManager

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Details - instructions to run and test the application.

Prerequisites

  • Node.js (v14 or higher)
  • Python (v3 or higher)

Installation and usage

  1. Clone the repository https://github.com/lidasusansabu13/SE577-Project.git
  2. Navigate to the cloned repo using the command cd SE577-Project
  3. Type the command git pull to get all latest updates.
  4. Type the command git checkout proj-Release-3 to switch to proj-Release-3 branch
  5. If you run the ls command you can see the folder structure:
├── Server
│
├── client
│
├── GitManagerArchitecture.jpg
│
└── Readme.md
  1. Make sure you have Python 3.x installed you can use these commanda $ sudo apt-get update $ sudo apt-get install python3.6

  2. You can make use of a virtual envirnment to avoid installation issues python3 -m venv se577venv and activate it by using the command source bin/activate after moving to the directory using cd se577venv after that cd ..

  3. Navigate to the Server directory and run pip install -r requirements.txt to install the necessary dependencies for the backend

  4. 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/

  5. Open a terminal and run python app.py or python3 app.pyto start backend server

  6. To check if the server is running open your web browser and navigate to http://localhost:8080/ to see the message 'Server is working....'

  7. Open your web browser and navigate to http://localhost:8080/repositories to get all repositories data

  8. Navigate to the client directory in a seperate terminal and run yarn to install the necessary dependencies for the frontend

  9. run yarn dev to start the frontend development server and it will open in http://localhost:5173/

  10. navigate to http://localhost:5173/projects to see the list of repositories.

Features

  • Feature 1: Under /repositories page, to get all repositories data

API Endpoints

  • http://localhost:8080/repositories: Get all repositories data.

Technologies Used

  • Vue.js
  • Python Flask

Highlevel architecture diagram

Highlevel architecture diagram

About

– Building a web-based, cloud-native, front end to GitHub that contains a dashboard that provides an overview of the repositories, issues, pull requests, and other activities for a specific user or organization. – Single-page application designed using Vue.js (JavaScript, HTML and CSS)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published