{"id":20800166,"url":"https://github.com/octagon-simon/fastamoni-inc-coding-exercise","last_synced_at":"2026-04-09T18:46:08.387Z","repository":{"id":233498391,"uuid":"787276863","full_name":"Octagon-simon/fastamoni-inc-coding-exercise","owner":"Octagon-simon","description":"The goal of this project is to access my proficiency in software engineering that is related to the daily work that is done at Fastamoni.","archived":false,"fork":false,"pushed_at":"2024-04-17T10:41:14.000Z","size":1874,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-18T12:22:17.594Z","etag":null,"topics":["artillery","express-js","fintech","fintech-api","javascript","jwt","mysql","nodejs","render"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Octagon-simon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-16T08:13:31.000Z","updated_at":"2024-04-17T10:33:16.000Z","dependencies_parsed_at":null,"dependency_job_id":"b88e7315-b271-4693-9aa5-cc23eb14a1e3","html_url":"https://github.com/Octagon-simon/fastamoni-inc-coding-exercise","commit_stats":null,"previous_names":["octagon-simon/fastamoni-inc-coding-exercise"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Octagon-simon%2Ffastamoni-inc-coding-exercise","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Octagon-simon%2Ffastamoni-inc-coding-exercise/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Octagon-simon%2Ffastamoni-inc-coding-exercise/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Octagon-simon%2Ffastamoni-inc-coding-exercise/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Octagon-simon","download_url":"https://codeload.github.com/Octagon-simon/fastamoni-inc-coding-exercise/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243147273,"owners_count":20243744,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["artillery","express-js","fintech","fintech-api","javascript","jwt","mysql","nodejs","render"],"created_at":"2024-11-17T18:12:31.511Z","updated_at":"2026-04-09T18:46:03.332Z","avatar_url":"https://github.com/Octagon-simon.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## FASTAMONI CODING EXERCISE\n\nThe goal of this project is to access my proficiency in software engineering that is related to the daily work that is done at Fastamoni.\n\n## INSTALLATION\n\nClone or download this repo into your local machine and follow the instructions below to configure the server or you can use this link to view the project `https://fastamoni-inc-coding-exercise.onrender.com`\n\n\u003e Please note that the LIVE URL might not still be active when you visit this project some time in the future. As at now 17/04/2024, it is active.\n\n- Import `schema.sql` into your SQL server to create the Database and necessary Tables\n\n- Rename `.env.sample` to `.env` and provide values to the variables that are defined in this file\n\n- Run `npm install` to install the dependencies\n\n- Start the server with `npm run start` and make a call to `http://127.0.0.1:5000` in your browser to confirm if installation is successful.\n\nBelow you can see the available endpoints and what they do.\n\n## AVAILABLE ENDPOINTS\n\n\u003e Please note that all endpoints have this base URL `http://127.0.0.1:5000/api`\n\n- `/auth/signup` This endpoint enables a user to sign up on the server. It does not require authentication.\n\n    - Request Method: `POST`\n\n- `/auth/login` This endpoint enables a user to login to his account on the server. It does not require authentication.\n    \n    - Request Method: `POST`\n\n    - Once a user is logged in, an `accessToken` will be returned and you need to pass in this token to the request header as a bearer token in order to be **authenticated**. For example: `Bearer uytrFGBVCDRUI7654567yGBN8754rg...` \n\n- `/account/createPIN` This endpoint enables a loggedIn user to create a transaction PIN. It requires authentication.\n    \n    - Request Method: `POST`\n  \n    - With this PIN, the user can be able to donate some money to a beneficiary (another user)\n\n- `/wallets/getBalance` This endpoint enables a user to retrieve his wallet balance. It requires authentication.\n\n    - Request Method: `GET`\n  \n    - Once a user signs up on the server, an `NGN` wallet is automatically created with a default balance of `500,000` and this is enough to test donations to a different user.\n\n- `/donations/create` This endpoint enables a user to create a donation to a different user (beneficiary). It requires authentication\n\n    - Request Method: `POST`\n\n    - Before a donation is created, you must set up a PIN because this PIN will be used to verify and authenticate the user as funds are about to leave his wallet.\n\n- `/donations/getAll` This endpoint enables a user to get the records of all donations he has made.\n\n    - Request Method: `GET`\n\n    - You can filter the records by the date and it supports pagination too. Please refer to `fastaMoni.postman_collection.json` for more information\n\n- `/donations/getSingle` This endpoint enables a user to retrieve a single donation using the ID of the donation.\n\n    - Request Method: `GET`\n\n- `/donations/total` This endpoint enables a user to get the total donations he has made\n  \n    - Request Method: `GET`\n\n## WHAT YOU CAN DO\n\nImport the collection `fastaMoni.postman_collection.json` into POSTMAN and follow the instructions below\n\n- Signup on the server by creating 2 accounts, one for yourself and the other for a beneficiary.\n\n- Log into your own account and create a PIN\n\n- Once you have created your PIN, head over to the donations endpoint and create a new donation to your beneficiary and when you create 2 or more donations, you will receive an email, with a special thank you message.\n\n- Check your NGN wallet balance to confirm the funds you have left and then login as your beneficiary and check the wallet balance to confirm the funds he received.\n\n## STACK\n\n- NodeJS\n- Express\n- MySQL\n- JWT (for authentication)\n- Artillery (for testing)\n\n## THE EXERCISE\n\nPlease use [this link](https://github.com/Fastamoni/backend-test) to learn more about the exercise.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctagon-simon%2Ffastamoni-inc-coding-exercise","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foctagon-simon%2Ffastamoni-inc-coding-exercise","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctagon-simon%2Ffastamoni-inc-coding-exercise/lists"}