Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thlindustries/stoompizzas
Um projeto entusiasta para possibilitar que o usuário monte sua pizza e acumule pontos de benefício!
https://github.com/thlindustries/stoompizzas
json-api jsonserver react typescript
Last synced: 29 days ago
JSON representation
Um projeto entusiasta para possibilitar que o usuário monte sua pizza e acumule pontos de benefício!
- Host: GitHub
- URL: https://github.com/thlindustries/stoompizzas
- Owner: thlindustries
- Created: 2020-08-27T11:40:03.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-11T21:13:09.000Z (about 2 years ago)
- Last Synced: 2024-11-11T01:32:28.328Z (3 months ago)
- Topics: json-api, jsonserver, react, typescript
- Language: TypeScript
- Homepage:
- Size: 594 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Stoom Pizzas 🚀
## 💻 Sobre o projeto
📝 Stoom Pizzas - é um projeto desafiador entusiasta proposto pela empresa **stoom** em que um usário tem a possibilidade de montar sua pizza e juntar pontos de benfício.
## 🎨 Layout
## Web
## 🛠 Tecnologias
As seguintes ferramentas foram usadas na construção do projeto:
- [React][reactjs]
- [TypeScript][typescript]
- [JsonServer][jsonserver]
## 🚀 Como executar o projeto
💡Para o correto funcionamento do app web é necessário que o servidor backend esteja rodando.
### 🎲 **Back End (servidor)**
- Para o cumprimento dos requisitos foi utilizado uma Lib chamada
**JSON SERVER**
, onde um arquivo JSON funciona como se fosse um servidor/banco de dados.
- As informações sobre os **dados** que a API está servindo podem ser encontradas na pasta:
**services/server.json**
### Pré-requisitos
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas:
[Git](https://git-scm.com).
Além disto é bom ter um editor para trabalhar com o código como [VSCode][vscode]
### 🎲 Rodando o **Back End (servidor)**
```bash
# Clone este repositório
$ git clone https://github.com/thlindustries/stoompizzas
# Acesse a pasta do projeto no terminal/cmd
$ cd stoompizzas
# Instale as dependências
$ yarn
ou
$ npm i
# Execute o servidor fake
$ yarn server
ou
$ npx json-server src/services/server.json --port 3333
# O servidor inciará na porta:3333 - acesse http://localhost:3333
```
### 📱Rodando a aplicação **WEB**
```bash
# Acesse a pasta do projeto web
$ cd stoompizzas
# Instale as dependências
$ yarn
ou
$ npm i
# Inicie o servidor
$ yarn start
ou
$ npm start
# Entre em > http://localhost:3000 <
```
## 😯 Como contribuir para o projeto
1. Faça um **fork** do projeto.
2. Crie uma nova branch com as suas alterações: `git checkout -b my-feature`
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: `git commit -m "feature: My new feature"`
4. Envie as suas alterações: `git push origin my-feature`
> Caso tenha alguma dúvida confira este [guia de como contribuir no GitHub](https://github.com/firstcontributions/first-contributions)
## 👥 Contribuidores
- Thiago Lorente Kraetzer ->
## 📝 Licença
Este projeto esta sobe a licença MIT.
Feito com ❤️ por Thiago Lorente Kraetzer 👋🏽 [Entre em contato!](https://www.linkedin.com/in/thiago-kraetzer/)
[nodejs]: https://nodejs.org/
[typescript]: https://www.typescriptlang.org/
[jsonserver]: https://github.com/typicode/json-server
[reactjs]: https://reactjs.org
[yarn]: https://yarnpkg.com/
[vscode]: https://code.visualstudio.com/
[vceditconfig]: https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig
[license]: https://opensource.org/licenses/MIT
[vceslint]: https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint
[prettier]: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode
[rs]: https://rocketseat.com.br