Skip to content

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@DuckyMomo20012
DuckyMomo20012 committed Mar 22, 2023
1 parent 384ae50 commit 552ea24
Showing 1 changed file with 75 additions and 137 deletions.
212 changes: 75 additions & 137 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,42 +1,42 @@
<div align="center">

<img src="public/img/react.svg" alt="logo" width="200" height="auto" />
<h1>React Template</h1>
<h1>Password Cracking Demo</h1>

<p>
A simple React template
Proof of concept for Hydra and Hashcat
</p>

<!-- Badges -->
<p>
<a href="https://github.com/DuckyMomo20012/react-template/graphs/contributors">
<img src="https://img.shields.io/github/contributors/DuckyMomo20012/react-template" alt="contributors" />
<a href="https://github.com/DuckyMomo20012/pw-crack-demo/graphs/contributors">
<img src="https://img.shields.io/github/contributors/DuckyMomo20012/pw-crack-demo" alt="contributors" />
</a>
<a href="">
<img src="https://img.shields.io/github/last-commit/DuckyMomo20012/react-template" alt="last update" />
<img src="https://img.shields.io/github/last-commit/DuckyMomo20012/pw-crack-demo" alt="last update" />
</a>
<a href="https://github.com/DuckyMomo20012/react-template/network/members">
<img src="https://img.shields.io/github/forks/DuckyMomo20012/react-template" alt="forks" />
<a href="https://github.com/DuckyMomo20012/pw-crack-demo/network/members">
<img src="https://img.shields.io/github/forks/DuckyMomo20012/pw-crack-demo" alt="forks" />
</a>
<a href="https://github.com/DuckyMomo20012/react-template/stargazers">
<img src="https://img.shields.io/github/stars/DuckyMomo20012/react-template" alt="stars" />
<a href="https://github.com/DuckyMomo20012/pw-crack-demo/stargazers">
<img src="https://img.shields.io/github/stars/DuckyMomo20012/pw-crack-demo" alt="stars" />
</a>
<a href="https://github.com/DuckyMomo20012/react-template/issues/">
<img src="https://img.shields.io/github/issues/DuckyMomo20012/react-template" alt="open issues" />
<a href="https://github.com/DuckyMomo20012/pw-crack-demo/issues/">
<img src="https://img.shields.io/github/issues/DuckyMomo20012/pw-crack-demo" alt="open issues" />
</a>
<a href="https://github.com/DuckyMomo20012/react-template/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/DuckyMomo20012/react-template.svg" alt="license" />
<a href="https://github.com/DuckyMomo20012/pw-crack-demo/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/DuckyMomo20012/pw-crack-demo.svg" alt="license" />
</a>
</p>

<h4>
<a href="https://github.com/DuckyMomo20012/react-template/">View Demo</a>
<a href="https://github.com/DuckyMomo20012/pw-crack-demo/">View Demo</a>
<span> · </span>
<a href="https://github.com/DuckyMomo20012/react-template">Documentation</a>
<a href="https://github.com/DuckyMomo20012/pw-crack-demo">Documentation</a>
<span> · </span>
<a href="https://github.com/DuckyMomo20012/react-template/issues/">Report Bug</a>
<a href="https://github.com/DuckyMomo20012/pw-crack-demo/issues/">Report Bug</a>
<span> · </span>
<a href="https://github.com/DuckyMomo20012/react-template/issues/">Request Feature</a>
<a href="https://github.com/DuckyMomo20012/pw-crack-demo/issues/">Request Feature</a>
</h4>
</div>

Expand All @@ -47,16 +47,11 @@
# :notebook_with_decorative_cover: Table of Contents

- [About the Project](#star2-about-the-project)
- [Screenshots](#camera-screenshots)
- [Tech Stack](#space_invader-tech-stack)
- [Features](#dart-features)
- [Color Reference](#art-color-reference)
- [Environment Variables](#key-environment-variables)
- [Getting Started](#toolbox-getting-started)
- [Prerequisites](#bangbang-prerequisites)
- [Run Locally](#running-run-locally)
- [Running Tests](#test_tube-running-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [Usage](#eyes-usage)
- [Roadmap](#compass-roadmap)
- [Contributing](#wave-contributing)
Expand All @@ -70,71 +65,6 @@

## :star2: About the Project

<!-- Screenshots -->

### :camera: Screenshots

<div align="center">
<p>Light mode</p>
<img src="https://user-images.githubusercontent.com/64480713/215486886-ae1098c1-89d3-42d3-9db6-8dc1fd3b8cca.png" alt="screenshot" />
<p>Dark mode</p>
<img src="https://user-images.githubusercontent.com/64480713/215486719-3e76a855-c828-4f3b-8e31-21f9d2740321.png" alt="screenshot_dark_mode" />
</div>

<!-- TechStack -->

### :space_invader: Tech Stack

<details>
<summary>Client</summary>
<ul>
<li><a href="https://www.javascript.com/">Javascript</a></li>
<li><a href="https://reactjs.org/">React.js</a></li>
<li><a href="https://reactrouter.com/">React Router</a></li>
<li><a href="https://redux-toolkit.js.org/">Redux Toolkit</a></li>
<li><a href="https://tanstack.com/query/v4">TanStack Query</a></li>
<li><a href="https://react-hook-form.com/">React Hook Form</a></li>
<li><a href="https://windicss.org/">WindiCSS</a></li>
<li><a href="https://mantine.dev/">Mantine</a></li>
<li><a href="https://eslint.org/">ESLint</a></li>
<li><a href="https://prettier.io/">Prettier</a></li>
<li><a href="https://vitejs.dev/">Vite</a></li>
<li><a href="https://vitest.dev/">Vitest</a></li>
<li><a href="https://playwright.dev/">Playwright</a></li>
<li><a href="https://iconify.design/">Iconify</a></li>
</ul>
</details>

<details>
<summary>Server</summary>
<ul>
<li><a href="https://www.typescriptlang.org/">Typescript</a></li>
<li><a href="https://expressjs.com/">Express.js</a></li>
<li><a href="https://go.dev/">Golang</a></li>
<li><a href="https://nestjs.com/">Nest.js</a></li>
<li><a href="https://socket.io/">SocketIO</a></li>
<li><a href="https://www.prisma.io/">Prisma</a></li>
<li><a href="https://www.apollographql.com/">Apollo</a></li>
<li><a href="https://graphql.org/">GraphQL</a></li>
</ul>
</details>

<details>
<summary>Database</summary>
<ul>
<li><a href="https://www.mongodb.com/">MongoDB</a></li>
</ul>
</details>

<details>
<summary>DevOps</summary>
<ul>
<li><a href="https://www.docker.com/">Docker</a></li>
<li><a href="https://www.jenkins.io/">Jenkins</a></li>
<li><a href="https://circleci.com/">CircleCLI</a></li>
</ul>
</details>

<!-- Features -->

### :dart: Features
Expand All @@ -143,33 +73,24 @@
- Feature 2.
- Feature 3.

<!-- Color Reference -->

### :art: Color Reference

| Color | Hex |
| --------------- | ---------------------------------------------------------------- |
| Primary Color | ![#222831](https://placehold.jp/222831/222831/10x10.png) #222831 |
| Secondary Color | ![#393E46](https://placehold.jp/393E46/393E46/10x10.png) #393E46 |
| Accent Color | ![#00ADB5](https://placehold.jp/00ADB5/00ADB5/10x10.png) #00ADB5 |
| Text Color | ![#EEEEEE](https://placehold.jp/EEEEEE/EEEEEE/10x10.png) #EEEEEE |

<!-- Env Variables -->

### :key: Environment Variables

To run this project, you will need to add the following environment variables to
your `.env` file:

- **App configs:**
- **DB configs:**

`VITE_TEST_VAR`: Description of this environment variable.
`POSTGRES_USER`: Postgres user.
`POSTGRES_PASSWORD`: Postgres password.

E.g:

```
# .env
VITE_TEST_VAR="my secret key"
POSTGRES_USER=postgres
POSTGRES_PASSWORD=***
```

You can also check out the file `.env.example` to see all required environment
Expand All @@ -183,58 +104,75 @@ variables.

### :bangbang: Prerequisites

This project uses [pnpm](https://pnpm.io/) as package manager:
- [Docker](https://www.docker.com/) installed locally:

```bash
npm install --global pnpm
```
```bash
#!/usr/bin/env bash

<!-- Run Locally -->
# Uninstall old versions
sudo apt-get remove docker docker-engine docker.io containerd runc

### :running: Run Locally
# Set up the repository

Clone the project:
# Update the apt package index and install packages to allow apt to use a
# repository over HTTPS
sudo apt-get update

```bash
git clone https://github.com/DuckyMomo20012/react-template.git
```
sudo apt-get install \
ca-certificates \
curl \
gnupg \
lsb-release

Go to the project directory:
# Add Docker’s official GPG key
sudo mkdir -m 0755 -p /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg

```bash
cd react-template
```
# Use the following command to set up the repository
echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

Install dependencies:
# Install Docker Engine

```bash
pnpm install
```
# Update the apt package index
sudo apt-get update

Start the server:
# Install Docker Engine, containerd, and Docker Compose.
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

```bash
pnpm dev
```
# Post installation steps

<!-- Running Tests -->
# Add your user to the docker group
sudo usermod -aG docker $USER
```

### :test_tube: Running Tests
<!-- Run Locally -->

To run tests, run the following command:
### :running: Run Locally

Clone the project:

```bash
git clone https://github.com/DuckyMomo20012/pw-crack-demo.git
```

Go to the project directory:

```bash
pnpm test
cd pw-crack-dem
```

<!-- Deployment -->
Run the project using `docker-compose`:

### :triangular_flag_on_post: Deployment
```bash
docker compose up -d
```

To deploy this project run:
Finally, you can stop the project by running:

```bash
pnpm deploy
docker compose down -v
```

<!-- Usage -->
Expand All @@ -246,7 +184,7 @@ Show additional screenshots, code samples, demos, or links to other resources.

```jsx
// foo.jsx
import Component from 'react-template';
import Component from "react-template";

function App() {
return <Component />;
Expand All @@ -264,8 +202,8 @@ function App() {

## :wave: Contributing

<a href="https://github.com/DuckyMomo20012/react-template/graphs/contributors">
<img src="https://contrib.rocks/image?repo=DuckyMomo20012/react-template" />
<a href="https://github.com/DuckyMomo20012/pw-crack-demo/graphs/contributors">
<img src="https://contrib.rocks/image?repo=DuckyMomo20012/pw-crack-demo" />
</a>

Contributions are always welcome!
Expand All @@ -274,7 +212,7 @@ Contributions are always welcome!

### :scroll: Code of Conduct

Please read the [Code of Conduct](https://github.com/DuckyMomo20012/react-template/blob/main/CODE_OF_CONDUCT.md).
Please read the [Code of Conduct](https://github.com/DuckyMomo20012/pw-crack-demo/blob/main/CODE_OF_CONDUCT.md).

<!-- FAQ -->

Expand All @@ -293,7 +231,7 @@ Please read the [Code of Conduct](https://github.com/DuckyMomo20012/react-templa
## :warning: License

Distributed under MIT license. See
[LICENSE](https://github.com/DuckyMomo20012/react-template/blob/main/LICENSE)
[LICENSE](https://github.com/DuckyMomo20012/pw-crack-demo/blob/main/LICENSE)
for more information.

<!-- Contact -->
Expand All @@ -303,7 +241,7 @@ for more information.
Duong Vinh - [@duckymomo20012](https://twitter.com/duckymomo20012) -
tienvinh.duong4@gmail.com

Project Link: [https://github.com/DuckyMomo20012/react-template](https://github.com/DuckyMomo20012/react-template).
Project Link: [https://github.com/DuckyMomo20012/pw-crack-demo](https://github.com/DuckyMomo20012/pw-crack-demo).

<!-- Acknowledgments -->

Expand Down

0 comments on commit 552ea24

Please sign in to comment.