Github Clone - The MVP

Functionalities of this github_clone:

• Authentification
• Register
• Confirm Registration by Email
• Create Repository
• List of repositories by username
• Search repository
• ... in development <>

Table of Content

• Environment
• Technologies
• Installation
• File Descriptions
• Examples of use
• Bugs
• Authors
• License

Environment

This project can run anywhere

Technologies

• Frontend: [ HTML, CSS, JavaScript & TypeScript, Angular 15+]
• Backend: [Java 11 or higher | Spring Boot 2+]
• Database: MySQL 8+
• Version Control: Install Git
• Maven: Install Maven
• Npm: Install npm

Installation

• Clone this repository: git clone https://github.com/alban-okoby/github_clone.git

  Frontend project

• Access frontend project directory: cd github_clone/frontend
• Install dependencies npm i
• Start project npm start or ng serve if you have angular on your device
• Go to localhost:4200 by default on your browser.

  Backend project

  • Access backend project directory: cd github_clone/backend/github_clone_api
  • Install dependancies : mvn install package or mvn clean install
  • Run api with java -jar target/github-clone-1.1.0.jar

File Descriptions

Examples of use

By default the api will automaticaly create Credentials to login:

• "email": admin@github-clone.com,
• "password": admin@1234

Bugs

No known bugs at this time.

Authors

Alban Okoby - Github | Linkedln | Twitter

License

Public Domain. No copy write protection.