Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@wrujel
wrujel committed Mar 25, 2024
1 parent bff5efb commit 9606423
Show file tree
Hide file tree
Showing 2 changed files with 121 additions and 112 deletions.
233 changes: 121 additions & 112 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,110 +1,48 @@
<div align="center">
<h1>Github History App</h1>
<div align='center'>

[![Deploy][deploy-active]](/)
[![Tests][tests-passed]](/)
[![Buy me a coffee][buy-me-a-coffee]][buy-me-a-coffee-link]

</div>

<div align="center">
<a href="/README.md">
<img
src="https://img.shields.io/badge/Status-Complete-success.svg"
alt="Status"
/>
</a>
<a href="/package.json">
<img
src="https://img.shields.io/badge/Version-2.0.0-blue.svg"
alt="Version"
/>
</a>
<a href="/LICENSE">
<img
src="https://img.shields.io/badge/License-MIT-green.svg"
alt="License"
/>
</a>
<a href="https://vercel.com/">
<div align='center'>
<a href='/'>
<img
src="https://img.shields.io/badge/vercel-Deployed-success.svg?style=flat&logo=vercel"
alt="Deployed on Vercel"
/>
</a>
<a href="https://railway.app/">
<img
src="https://img.shields.io/badge/Railway-API Deployed-success.svg?style=flat&logo=railway"
alt="Deployed on Railway"
/>
</a>
<a href="https://nextjs.org/">
<img
src="https://img.shields.io/badge/Next.js-12.0.0+-blue.svg?style=flat&logo=next.js"
alt="Next.js version"
/>
</a>
<a href="https://nestjs.com/">
<img
src="https://img.shields.io/badge/NestJS-8.0.0+-blue.svg?style=flat&logo=nestjs"
alt="NestJS version"
/>
</a>
<a href="https://nodejs.org/">
<img
src="https://img.shields.io/badge/Node.js-16.15.0+-blue.svg?style=flat&logo=node.js"
alt="Node.js version"
/>
</a>
<a href="https://www.typescriptlang.org/">
<img
src="https://img.shields.io/badge/Typescript-4.4.4+-blue.svg?style=flat&logo=typescript"
alt="Typescript version"
/>
</a>
<a href="https://tailwindcss.com/">
<img
src="https://img.shields.io/badge/Tailwindcss-2.2.17+-blue.svg?style=flat&logo=tailwindcss"
alt="Tailwindcss version"
/>
</a>
<a href="https://jestjs.io/">
<img
src="https://img.shields.io/badge/Jest-27.2.5+-blue.svg?style=flat&logo=jest"
alt="Jest version"
/>
</a>
<a href="https://reactjs.org/">
<img
src="https://img.shields.io/badge/React-17.0.2+-blue.svg?style=flat&logo=react"
alt="React version"
/>
</a>
<a href="https://docs.github.com/en/rest">
<img
src="https://img.shields.io/badge/Github%20API-Complete-blue.svg?style=flat&logo=github"
alt="Github API version"
/>
</a>
<a href="https://date-fns.org/">
<img
src="https://img.shields.io/badge/Date--fns-2.25.0+-blue.svg?style=flat&logo=date-fns"
alt="Date-fns version"
/>
</a>
<a href="https://swagger.io/">
<img
src="https://img.shields.io/badge/Swagger-4.4.0+-blue.svg?style=flat&logo=swagger"
alt="Swagger version"
/>
</a>
<a href="https://react-hot-toast.com/">
<img
src="https://img.shields.io/badge/React--Hot--Toast-1.0.0+-blue.svg?style=flat&logo=react-hot-toast"
alt="React-Hot-Toast version"
src='/frontend/public/screenshot.png'
alt='Screenshot of the app'
/>
</a>
</div>
<br />

This app will show you a list of all commits of a github repository. You can search by username, select the repository and branch you want to search and it will show you a list of all commits respectively.
<div align="center">
<h1>Github History App</h1>
</div>

<div align="center">

[![Next.js][nextjs]][nextjs-link]
[![Typescript][typescript]][typescript-link]
[![Tailwind CSS][tailwindcss]][tailwindcss-link]
[![React][react]][react-link]
[![Github API][github-api]][github-api-link]
[![Date-fns][date-fns]][date-fns-link]
[![React-Hot-Toast][react-hot-toast]][react-hot-toast-link]
[![Vercel][vercel]][vercel-link]
[![Node.js][nodejs]][nodejs-link]
[![NestJS][netsjs]][netsjs-link]
[![Swagger][swagger]][swagger-link]
[![Jest][jest]][jest-link]

</div>

# Table of Contents
<div align='center'>
This app will show you a list of all commits of a github repository. You can search by username, select the repository and branch you want to search and it will show you a list of all commits respectively.

[Demo](https://github-history.vercel.app/) · [Report issue](/issues) · [Suggest something](/issues)
</div>

## Table of Contents
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Tech Stack](#tech-stack)
Expand All @@ -120,7 +58,7 @@ This app will show you a list of all commits of a github repository. You can sea
- [Running client](#running-client)
- [Try Demo](#try-demo)

# Features
## Features
- [x] Show a list of all repositories of a Github user.
- [x] Show a list of all branches of a Github repository.
- [x] Show a list of all commits of a Github repository.
Expand All @@ -134,7 +72,7 @@ This app will show you a list of all commits of a github repository. You can sea
- [x] Typescript was used in backend and frontend.
- [x] Use React-Hot-Toast to show notification messages.

# Tech Stack
## Tech Stack
- [NestJS](https://nestjs.com/)
- [NextJS](https://nextjs.org/)
- [NodeJS](https://nodejs.org/)
Expand All @@ -149,10 +87,10 @@ This app will show you a list of all commits of a github repository. You can sea
- [Railway](https://railway.app/)
- [React-Hot-Toast](https://react-hot-toast.com/)

# Getting Started
## Getting Started
This is a mono repository project that is divided in two parts, the backend and the frontend. The backend is developed with [NestJS](https://nestjs.com/) and the frontend with [NextJS](https://nextjs.org/).

## Cloning the repository
### Cloning the repository
Open a command prompt, and copy the following command, you need to have installed [git](https://git-scm.com/).
```
git clone https://github.com/wrujel/github-history.git
Expand All @@ -168,19 +106,19 @@ Receiving objects: 100% (138/138), 230.03 KiB | 747.00 KiB/s, done.
Resolving deltas: 100% (54/54), done.
```

## Setup Backend
### Setup Backend
Type the following command:
```
cd github-history/backend
```

### Installation
#### Installation
Install all dependencies, you need to have installed [nodejs](https://nodejs.org/) version 16.15.0.
```bash
npm install
```

### Running server
#### Running server
Commands to run backend server, use `start:dev` if you want to automatically reset server after saving changes.
```bash
# development
Expand All @@ -200,13 +138,13 @@ Open your browser and copy following url to see result:
http://localhost:8080/
```

### Documentation
#### Documentation
You can visit following path to see documentation generated with swagger:
```
http://localhost:8080/api/docs
```

### Test
#### Test
Commands to test server.
```bash
# unit tests
Expand All @@ -216,19 +154,19 @@ npm run test
npm run test:e2e
```

## Setup Frontend
### Setup Frontend
In the root of project, type the following command:
```
cd github-history/frontend
```

### Installation
#### Installation
Install all dependencies, you need to have installed [nodejs](https://nodejs.org/) version 16.15.0.
```bash
npm install
```

### Running client
#### Running client
Run the development server:

```bash
Expand All @@ -239,5 +177,76 @@ yarn dev

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

# Try Demo
## Try Demo
The project is deployed with Vercel. Open this link with your browser to see demo. https://github-history.vercel.app/


<!-- Badges -->
[deploy-active]: https://img.shields.io/badge/Deploy-Active-success?style=for-the-badge&logoColor=white
[tests-passed]: https://img.shields.io/badge/Test-Passed-success?style=for-the-badge&color=green
[buy-me-a-coffee]: https://img.shields.io/badge/Buy%20me%20a%20coffee-FF813F?style=for-the-badge&logo=buy-me-a-coffee
[nextjs]: https://img.shields.io/badge/Next.js-black?style=for-the-badge&logo=next.js
[typescript]: https://img.shields.io/badge/Typescript-007ACC?style=for-the-badge&logo=typescript&logoColor=white&color=blue
[tailwindcss]: https://img.shields.io/badge/Tailwind%20CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white
[react]: https://img.shields.io/badge/React-61DAFB?style=for-the-badge&logo=react&logoColor=white
[lodash]: https://img.shields.io/badge/Lodash-gray?style=for-the-badge&logo=lodash
[next-auth]: https://img.shields.io/badge/Next--Auth-black?style=for-the-badge&logo=next.js
[prisma]: https://img.shields.io/badge/Prisma-2D3748?style=for-the-badge&logo=prisma&logoColor=white
[axios]: https://img.shields.io/badge/Axios-56A7F7?style=for-the-badge&logo=axios&logoColor=white
[react-icons]: https://img.shields.io/badge/React--Icons-61DAFB?style=for-the-badge&logo=react&logoColor=white
[swr]: https://img.shields.io/badge/SWR-black?style=for-the-badge&logo=next.js
[zustand]: https://img.shields.io/badge/Zustand-gray?style=for-the-badge&logo=npm
[react-player]: https://img.shields.io/badge/React--Player-gray?style=for-the-badge&logo=npm
[mongodb]: https://img.shields.io/badge/MongoDB-47A248?style=for-the-badge&logo=mongodb&logoColor=white
[vercel]: https://img.shields.io/badge/Vercel-000000?style=for-the-badge&logo=vercel&logoColor=white
[html]: https://img.shields.io/badge/HTML5-E34F26?style=for-the-badge&logo=html5&logoColor=white
[css]: https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white
[javascript]: https://img.shields.io/badge/JavaScript-323330?style=for-the-badge&logo=javascript&logoColor=F7DF1E
[netlify]: https://img.shields.io/badge/Netlify-00C7B7?style=for-the-badge&logo=netlify&logoColor=white
[vite]: https://img.shields.io/badge/Vite-646CFF?style=for-the-badge&logo=vite&logoColor=white
[astro]: https://img.shields.io/badge/Astro-0C1222?style=for-the-badge&logo=astro&logoColor=FDFDFE
[express]: https://img.shields.io/badge/Express%20js-000000?style=for-the-badge&logo=express&logoColor=white
[mongoose]: https://img.shields.io/badge/Mongoose-gray?style=for-the-badge&logo=mongoose&logoColor=white
[angular]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
[angular-material]: https://img.shields.io/badge/Angular%20Material-607D8B?style=for-the-badge&logo=angular&logoColor=white
[nodejs]: https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=node.js&logoColor=white
[netsjs]: https://img.shields.io/badge/NestJS-E0234E?style=for-the-badge&logo=nestjs&logoColor=white
[swagger]: https://img.shields.io/badge/Swagger-85EA2D?style=for-the-badge&logo=swagger&logoColor=white
[jest]: https://img.shields.io/badge/Jest-C21325?style=for-the-badge&logo=jest&logoColor=white
[react-hot-toast]: https://img.shields.io/badge/React--Hot--Toast-gray?style=for-the-badge&logo=react-hot-toast&logoColor=white
[github-api]: https://img.shields.io/badge/Github%20API-181717?style=for-the-badge&logo=github&logoColor=white
[date-fns]: https://img.shields.io/badge/Date--fns-F7841B?style=for-the-badge&logo=date-fns&logoColor=white

<!-- Badges links -->
[buy-me-a-coffee-link]: https://www.buymeacoffee.com/wrujel
[nextjs-link]: https://nextjs.org/
[typescript-link]: https://www.typescriptlang.org/
[tailwindcss-link]: https://tailwindcss.com/
[react-link]: https://reactjs.org/
[lodash-link]: https://lodash.com/
[next-auth-link]: https://next-auth.js.org/
[prisma-link]: https://www.prisma.io/
[axios-link]: https://axios-http.com/
[react-icons-link]: https://react-icons.github.io/react-icons/
[swr-link]: https://swr.vercel.app/
[zustand-link]: https://zustand.surge.sh/
[react-player-link]: https://www.npmjs.com/package/react-player
[mongodb-link]: https://www.mongodb.com/
[vercel-link]: https://vercel.com/
[html-link]: https://developer.mozilla.org/en-US/docs/Web/HTML
[css-link]: https://developer.mozilla.org/en-US/docs/Web/CSS
[javascript-link]: https://developer.mozilla.org/en-US/docs/Web/JavaScript
[netlify-link]: https://www.netlify.com/
[vite-link]: https://vitejs.dev/
[astro-link]: https://astro.build/
[express-link]: https://expressjs.com/
[mongoose-link]: https://mongoosejs.com/
[angular-link]: https://angular.io/
[angular-material-link]: https://material.angular.io/
[nodejs-link]: https://nodejs.org/en/
[netsjs-link]: https://nestjs.com/
[swagger-link]: https://swagger.io/
[jest-link]: https://jestjs.io/
[react-hot-toast-link]: https://react-hot-toast.com/
[github-api-link]: https://docs.github.com/en/rest
[date-fns-link]: https://date-fns.org/
Binary file added frontend/public/screenshot.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9606423

Please sign in to comment.