https://github.com/logic-fabric/argent-bank-api
Source code supplied by OpenClassrooms to be used in a project of the Front-end Developer path
https://github.com/logic-fabric/argent-bank-api
openclassrooms-code
Last synced: 10 months ago
JSON representation
Source code supplied by OpenClassrooms to be used in a project of the Front-end Developer path
- Host: GitHub
- URL: https://github.com/logic-fabric/argent-bank-api
- Owner: logic-fabric
- Created: 2021-09-23T08:01:25.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-09-23T08:12:24.000Z (over 4 years ago)
- Last Synced: 2025-03-12T09:39:43.260Z (about 1 year ago)
- Topics: openclassrooms-code
- Language: JavaScript
- Homepage:
- Size: 743 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Project #10 - Argent Bank API
This codebase contains the code needed to run the backend for Argent Bank.
## Getting Started
### Prerequisites
Argent Bank uses the following tech stack:
- [Node.js v12](https://nodejs.org/en/)
- [MongoDB Community Server](https://www.mongodb.com/try/download/community)
Please make sure you have the right versions and download both packages. You can verify this by using the following commands in your terminal:
```bash
# Check Node.js version
node --version
# Check Mongo version
mongo --version
```
### Instructions
1. Fork this repo
1. Clone the repo onto your computer
1. Open a terminal window in the cloned project
1. Run the following commands:
```bash
# Install dependencies
npm install
# Start local dev server
npm run dev:server
# Populate database with two users
npm run populate-db
```
Your server should now be running at http://locahost:3001 and you will now have two users in your MongoDB database!
## Populated Database Data
Once you run the `populate-db` script, you should have two users in your database:
### Tony Stark
- First Name: `Tony`
- Last Name: `Stark`
- Email: `tony@stark.com`
- Password: `password123`
### Steve Rogers
- First Name: `Steve`,
- Last Name: `Rogers`,
- Email: `steve@rogers.com`,
- Password: `password456`
## API Documentation
To learn more about how the API works, once you have started your local environment, you can visit: http://localhost:3001/api-docs
## Design Assets
Static HTML and CSS has been created for most of the site and is located in: `/designs`.
For some of the dynamic features, like toggling user editing, there is a mock-up for it in `/designs/wireframes/edit-user-name.png`.
And for the API model that you will be proposing for transactitons, the wireframe can be found in `/designs/wireframes/transactions.png`.