warran / web /README.md
Jessedbrown's picture
Update README.md
2f93565
|
Raw History Blame Contribute Delete
949 Bytes
# ⌛️ API Node - Warren Code Challenge
<br>
----
<br>
## 🚀 Challenge
Create an SPA where users can check their statement and make new transactions such as deposits, payments and withdrawls
## 👨🏽‍💻 Tech Stack
- Node.js
- Typescript
- Express
- Jest
- Docker
- Mongoose
- MongoDB
- React
- Javascript
## 📝 Functional Requirements
- Get user statement
- Make a deposit
- Make a payment
- Make a withdrawl
- `TODO` Add transactions filter
- `TODO` Add pagination (backend ready)
## 🚙 How to run this application
1. `git clone` to download the repository;
2. `npm install` to install the dependencies;
3. `cd web && npm run start` to run the project locally at port `3030`;
## 🖼️ Preview
![Dashboard](https://i.imgur.com/FkIPpjw.png)
![Transaction Modal](https://i.imgur.com/Pg8gJ8D.png)
#### 👋🏽 How to reach me
Lourenço Passos | Fullstack Software Engineer | lo.passos93@gmail.com | 55-51-996106010