Isyaratlingo

Table of Contents

1. About
   • Built With
2. Getting Started
   • Installation
3. Contributing
4. License

About

Isyaratlingo

IsyaratLingo is a sign language learning platform that adopts interactive learning methods. This platform is designed to facilitate users from various backgrounds, including deaf people or the general public who want to learn sign language. With the concept of gamification and automated learning methods, IsyaratLingo aims to make the process of learning sign language more fun and effective. Through the use of technology and interactive features in this platform, users can understand sign language more easily, deeply, and improve their communication skills in Sign Language.

(back to top)

Built With

This Project is built with :

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Follow the instruction below to install the project locally.

Installation

Follow the steps below for installation of this project.

1. Clone the repo.

   git clone https://github.com/sodaAPI/web-isyaratlingo.git

2. Install NPM packages in ./backend/ and ./frontend/

   npm install

   or

   npm install --force

3. Add the database in your local server.
4. Setting your databases in ./backend/config/database.js, make sure you already create database in your local server.

   const db = new Sequelize("your_databases", "your_database_username", "your_database_password", {
   host: "localhost",
   dialect: "mysql",
   timezone: "+07:00", // Set your timezone
   pool: {
    max: 5,
    min: 0,
    acquire: 30000,
    idle: 10000,
    },
   });

5. Setting your .env in ./backend/.env.

APP_PORT = #Port
SESS_SECRET = #Random Number
SESSION_EXPIRED = #In Hour
URL_ORIGIN = #Client URL
EMAIL_API = #Email for nodemail
PASSWORD_API = #Email password for nodemail
EMAIL_HOST = #Email type for nodemail
EMAIL_PORT = #Email port for nodemail
BASE_DIR = #Base directory for server

6. Run your MySQL server (i'm using XAMPP).
7. Start Front-End on folder frontend

   npm start

8. Start Back-End in ./backend/ folder.

   nodemon

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/newFeature)
3. Commit your Changes (git commit -m 'Add some newFeature')
4. Push to the Branch (git push origin feature/newFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)