repo for EdTech project
This site is being hosted at https://translatesongs.com/.
Swagger UI at http://34.231.208.116:7075/swagger/index.html.
Segmentation API is http://translatesongs.com:7074/swagger/index.html
Requirements:
- Node 18 (latest)
cd frontend
npm start
More information available in frontend's README.
Build then run the container locally:
docker build -t edtech-frontend-local:latest .
docker run -d --name edtech-frontend-local -p 49160:3000 edtech-frontend-local
From here it should be available locally on http://localhost:49160.
The database is a managed service, AWS RDS running Postgres.
For the database ORM (object relational mapper) we are using Entity Framework 6.
The backend service is an ASP.NET Core Web API.
Download Terraform on local.
To auth with AWS, download AWS CLI on local and setup a profile in the .aws folder.
On Windows, have my profile file in C:\Users\<name>\.aws\credentials.
Put in your secret key and access key like follows:
[default]
aws_access_key_id = <your_access_key_id>
aws_secret_access_key = <your_secret_access_key>
From the folder containing main.tf, run:
> terraform init
Then, run the following. If it tells you to download more plugins just follow the commands it gives you.
> terraform apply
To develop a tree-structure for character decomposition, we use over the character set provided by Wikicommons. This is the same character set used by the leading online Chinese dictionary MDGB. It is not meant for etymological purposes, and for that we can refer users to Uncle Hanzi, who has been doing work in this space since 1994. He most likely has the best understanding online on how to perform computations over Chinese character sets for etymological purposes.
I tend to call branches by the folder, feature, then feature name.
For instance, if you are doing a util feature to be used by the backend service, the branch would be backend/feat/pinyin-to-zhuyin.
This is how I normally structure group projects but generally just don't merge broken code to main please. Open to input if you have a better way to stay organized.