A web app aimed at teaching sign language. Test it for yourself by clicking here
This project was bootstrapped with Create React App.
In the project directory, you can run:
Installs packages for both the frontend and backend and goes into appropriate conda environment
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build
folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject
, you can’t go back!
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.
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.
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.
Installs the python environment from the enviroment file located in the api
folder and then returns the user to the original directory
Starts the flask back-end server
Runs unit tests for the backend
Runs front-end and back-end concurrently
Formats the everything inside the src
folder that has the extension .ts and .tsx using the .prettierrc
configuration file
Create React environment file cat .env.sample > .env
, fields are already filled in due to the fact that they are all meant for dev work
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
Contains the flask code used in setting up the database and making the routes for slt
This backend uses python's Flask framework and uses conda for package, environment, and dependency management
- NOTE commands might be different based on OS
- To create the appropriate python environment run
conda create -n slt-pip python=3.7
- To activate the environment run
conda activate slt-pip
- Install all necessary packages with pip:
python -m pip install -r requirements.txt
- Install all necessary packages with pip:
- To update the environment run
python -m pip freeze > requirements.txt
- To activate the environment run
- Create Flask environment file
cat .env.example > .env
and fill in appropriate fields - To delete Python environment run
conda remove env --name slt-pip --all
Our backend uses MongoDB as its DBMS, for making
a local database use the mongodb://127.0.0.1:27017/mydbname
as a connect string
- Assuming you have your environment setup, then use the command
flask run
to start the server
- To initiate unit testing, run
python test.py
inside theapi
folder