Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AB #27

Open
wants to merge 25 commits into
base: main
Choose a base branch
from
Open

AB #27

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 18 additions & 31 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,36 +1,23 @@
# IDE files
.idea
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# Logs
logs
*.log
# dependencies
/node_modules
/.pnp
.pnp.js

# Runtime data
pids
*.pid
*.seed
# testing
/coverage

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# production
/build

# Coverage directory used by tools like istanbul
coverage
# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release

# Dependency directory
# Commenting this out is preferred by some people, see
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
node_modules

# Users Environment Variables
.lock-wscript

# Runtime configuration for swagger app
config/runtime.yaml

.DS_Store
npm-debug.log*
yarn-debug.log*
yarn-error.log*
5 changes: 5 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"githubPullRequests.ignoredPullRequestBranches": [
"main"
]
}
90 changes: 44 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,72 +1,70 @@
# Argent Bank API
# Getting Started with Create React App

This codebase contains the code needed to run the backend for Argent Bank.
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Getting Started
## Available Scripts

### Prerequisites
In the project directory, you can run:

Argent Bank uses the following tech stack:
### `npm start`

- [Node.js v12](https://nodejs.org/en/)
- [MongoDB Community Server](https://www.mongodb.com/try/download/community)
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

Please make sure you have the right versions and download both packages. You can verify this by using the following commands in your terminal:
The page will reload when you make changes.\
You may also see any lint errors in the console.

```bash
# Check Node.js version
node --version
### `npm test`

# Check Mongo version
mongo --version
```
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### Instructions
### `npm run build`

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:
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

```bash
# Install dependencies
npm install
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

# Start local dev server
npm run dev:server
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

# Populate database with two users
npm run populate-db
```
### `npm run eject`

Your server should now be running at http://locahost:3001 and you will now have two users in your MongoDB database!
**Note: this is a one-way operation. Once you `eject`, you can't go back!**

## Populated Database Data
If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Once you run the `populate-db` script, you should have two users in your database:
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

### Tony Stark
You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

- First Name: `Tony`
- Last Name: `Stark`
- Email: `[email protected]`
- Password: `password123`
## Learn More

### Steve Rogers
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

- First Name: `Steve`,
- Last Name: `Rogers`,
- Email: `[email protected]`,
- Password: `password456`
To learn React, check out the [React documentation](https://reactjs.org/).

## API Documentation
### Code Splitting

To learn more about how the API works, once you have started your local environment, you can visit: http://localhost:3001/api-docs
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)

## Design Assets
### Analyzing the Bundle Size

Static HTML and CSS has been created for most of the site and is located in: `/designs`.
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)

For some of the dynamic features, like toggling user editing, there is a mock-up for it in `/designs/wireframes/edit-user-name.png`.
### Making a Progressive Web App

And for the API model that you will be proposing for transactitons, the wireframe can be found in `/designs/wireframes/transactions.png`.
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)

### Advanced Configuration

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)

### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

### `npm run build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
79 changes: 0 additions & 79 deletions designs/index.html

This file was deleted.

62 changes: 0 additions & 62 deletions designs/sign-in.html

This file was deleted.

75 changes: 0 additions & 75 deletions designs/user.html

This file was deleted.

Binary file removed designs/wireframes/edit-username.png
Binary file not shown.
Binary file removed designs/wireframes/transactions.png
Binary file not shown.
Loading