Skip to content

Commit 63b2281

Browse files
Updated README.md
1 parent 7c6b8e4 commit 63b2281

File tree

5 files changed

+140
-0
lines changed

5 files changed

+140
-0
lines changed

README.md

+140
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
<h2 align="center">
2+
<div>
3+
<img alt="Logo" title="#logo" src="public/nlw-heat.png" width="400"/>
4+
<div>
5+
</h2>
6+
7+
<h1 align="center">
8+
NLW Heat | ReactJS
9+
</h1>
10+
11+
<div align="center">
12+
13+
<a href="">
14+
<img src="https://img.shields.io/github/languages/count/RodrigoSaantos/nlw-heat-web.svg?color=%238257E5" alt="languages" >
15+
</a>
16+
17+
<a href="">
18+
<img src="https://img.shields.io/github/languages/top/RodrigoSaantos/nlw-heat-web.svg?color=%238257E5" alt="languagesTop" >
19+
</a>
20+
21+
<a href="">
22+
<img src="https://img.shields.io/github/repo-size/RodrigoSaantos/nlw-heat-web.svg?color=%238257E5" alt="repo-size" >
23+
</a>
24+
25+
<a href="">
26+
<img src="https://img.shields.io/github/last-commit/RodrigoSaantos/nlw-heat-web.svg?color=%238257E5" alt="last-commit" >
27+
</a>
28+
29+
</div>
30+
31+
<p align="center"> Application developed in the seventh edition of Rocketseat Next Level Week - Heat 💻🚀 </p>
32+
33+
<p align="center">
34+
<a href="#about">About</a> •
35+
<a href="#technologies">Technologies</a> •
36+
<a href="#usage">Usage</a> •
37+
<a href="#contribution">Contribution</a> •
38+
<a href="#author">Author</a> •
39+
<a href="#demo">Demo</a> •
40+
<a href="#license">License</a>
41+
</p>
42+
43+
<h1 align="center">
44+
<div style="display: flex; flex-direction: row;">
45+
<img width="400" style="border-radius: 10px" height="auto" alt="Dashboard" title="Dashboard" src="public/home.png" />
46+
<img width="400" style="border-radius: 10px" height="auto" alt="Users" title="Users" src="public/login.png" />
47+
<div>
48+
</h1>
49+
50+
<h4 align="center">
51+
📝 NLW#7 | ReactJS ⏰📈 Loading... 📝
52+
</h4>
53+
54+
<h2 id="about" > 🎯 About </h2>
55+
56+
Application developed in the next level week - heat #7 - @Rocketseat
57+
58+
<h2 id="technologies"> 🛠 Technologies </h2>
59+
60+
The following tools were used in the construction of the project:
61+
62+
- [ReactJS](https://reactjs.org)
63+
- [Vite](https://vitejs.dev/)
64+
- [NodeJS](https://nodejs.org/en/)
65+
- [Yarn](https://yarnpkg.com) or Npm
66+
- [VSCode](https://code.visualstudio.com)
67+
- [Git Bash](https://gitforwindows.org/)
68+
- [Sass](https://sass-lang.com/)
69+
- [Socket.io](https://socket.io/)
70+
71+
<h2 id="usage" > 👷 Usage </h2>
72+
73+
Required! Install git, node and yarn (or npm).
74+
75+
```bash
76+
# Clone Repository
77+
$ git clone https://github.com/RodrigoSaantos/nlw-heat-web.git
78+
79+
# Go to server folder
80+
$ cd nlw-heat-web
81+
82+
# Install Dependencies
83+
$ yarn
84+
# or
85+
$ npm install
86+
87+
# Run Aplication
88+
$ yarn dev
89+
# or
90+
$ npm run dev
91+
92+
# Access localhost
93+
http://localhost:3000
94+
```
95+
96+
To make this project more organized, I moved the applications **(rest api, web client)** to 2 different repositories.
97+
98+
Here are the links to them
99+
100+
- [REST API](https://github.com/RodrigoSaantos/nlw-heat-node.git)
101+
- [Web client](https://github.com/RodrigoSaantos/nlw-heat-web.git)
102+
103+
<h2 id="contribution"> 🤝 Contribution </h2>
104+
105+
This project is for study purposes too. All kinds of contributions are very welcome and appreciated!
106+
107+
- Fork this repository;
108+
- Create a branch with your feature: `git checkout -b my-feature`;
109+
- Commit your changes: `git commit -m 'feat: My new feature'`;
110+
- Push to your branch: `git push origin my-feature`.
111+
112+
<h2 id="author"> 💻 Author </h2>
113+
114+
<img style="border-radius: 50%;" src="https://github.com/RodrigoSaantos.png" width="100px;" alt="Rodrigo Santos"/>
115+
116+
By Rodrigo Santos 👋🏽 Find me:
117+
118+
[![Linkedin Badge](https://img.shields.io/badge/-RodrigoSantos-blue?style=flat-square&logo=Linkedin&logoColor=white&link=https://www.linkedin.com/in/rodrigo-dos-santos-silva-637225156/)](https://www.linkedin.com/in/rodrigo-dos-santos-silva-637225156/)
119+
|
120+
[![Gmail Badge](https://img.shields.io/badge/-contato.rodrigosaantos@gmail.com-c14438?style=flat-square&logo=Gmail&logoColor=white&link=mailto:contato.rodrigosaantos@gmail.com)](mailto:contato.rodrigosaantos@gmail.com)
121+
122+
<h2 id="demo"> 🎌 Demo </h2>
123+
124+
<h1 align="center">
125+
<div style="display: flex; flex-direction: row;">
126+
<img width="900" style="border-radius: 10px" height="auto" alt="Login" title="Login" src="public/demo.gif" />
127+
<div>
128+
129+
Mobile
130+
---
131+
Dashboard | Users | Menu
132+
--- | --- | ---
133+
<img width="300" style="border-radius: 10px" height="600" alt="Login" title="Login" src="public/mobile-dashboard.png" /> | <img width="300" style="border-radius: 10px" height="600" alt="Login" title="Login" src="public/mobile-users.png" /> | <img width="300" style="border-radius: 10px" height="600" alt="Login" title="Login" src="public/mobile-menu.png" />
134+
</h1>
135+
136+
137+
138+
<h2 id="license"> 📝 License </h2>
139+
140+
This project is under the MIT license.

public/demo.gif

743 KB
Loading

public/home.png

320 KB
Loading

public/login.png

312 KB
Loading

public/nlw-heat.png

57.6 KB
Loading

0 commit comments

Comments
 (0)