https://github.com/calladrus2001/codestar-backend
https://github.com/calladrus2001/codestar-backend
alchemy aws-polly aws-s3 expressjs mongodb nodejs polygon solidity
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/calladrus2001/codestar-backend
- Owner: Calladrus2001
- Created: 2022-10-20T04:31:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-28T14:24:17.000Z (about 2 years ago)
- Last Synced: 2025-01-16T10:34:16.309Z (5 months ago)
- Topics: alchemy, aws-polly, aws-s3, expressjs, mongodb, nodejs, polygon, solidity
- Language: JavaScript
- Homepage:
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Code:Star Backend
This is the Node.js backend for my **Flutter** App.
## Tech Stack
**Server:** Node.js, Express.js
**Database:** MongoDB
**APIs:** Hedera Web3 Javascript SDK
**Client:** [Link to Client App Repo](https://github.com/Calladrus2001/Code-Star)
## Installation
Clone the repo and run `npm i` to install the dependencies.
As of now, the project isn't deployed so to access the APIs from a public url use **ngrok**. Download from [here](https://ngrok.com/download).
You would also need to setup your **Hedera** Testnet credentials, checkout the next section for more info.
## Environment Variables
To run this project, you will need to add the following environment variables to your `.env` file
```
HEDERA_PVT_KEY="YOUR_PRIVATE_KEY"
HEDERA_PUB_KEY="YOUR_PUBLIC_KEY"
HEDERA_ACC_ID="YOUR_ACCOUNT_ID"
HEDERA_newCID = "0.0.CONTRACT_ID"
```
Furtheremore, uncomment `line 54` in `/hedera/contract.js` to initialise the Smart contract, you would get the *new Contract ID* in console logs, put that value in `HEDERA_newCID` in your `.env` file. Comment `line 54` again.
After replacing `Flutter TTS` with `AWS Polly`, some additional changes are required. Follow [this link](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-shared.html) and make sure that you are using the right IAM User Credentials.
## API Reference
Checkout my Postman API collection below:
[](https://app.getpostman.com/run-collection/20360721-600d6471-c4b1-43ed-8d24-44f2b5beac4a?action=collection%2Ffork&collection-url=entityId%3D20360721-600d6471-c4b1-43ed-8d24-44f2b5beac4a%26entityType%3Dcollection%26workspaceId%3Db2c849e2-484f-4dcd-bbe6-daf758f94b9b)
## Future Roadmap
- ~~AWS Polly for Speech Synthesis~~
- AWS Deployement
## Acknowledgements
This is a list of resources that helped me immensely while making this project.
- [Andrew Mead's Udemy Course]()
- [Hedera's Javascript Tutorial Playlist](https://www.youtube.com/playlist?list=PLcaTa5RR9SuA__8rzCKru8Y_F6iMJPEUD)