rebeldi / dictionary_project_slu Goto Github PK

Right now the application only supports local deployment. In order to run it, you need to have nodejs, python and pip installed on your system. After you make sure to satisfy the requirement, go with command shell or terminal to directory of this repository on your machine. You need to run the settings.sh, which will download all the needed modules for proper work of the application, it is a shell script that you can run in Windows with:

In Linux: First make it executable

Then run it:

In MacOs:

**Then execute the file back end/nltk_settings.py. Use this link to download trained models, then unarchive the zip and replace back end/trained folder with the folder in zip:

You will automatically be transfered to the web page of the application in your local browser. Enjoy!

This application is build using ReactJS, in order for it to work on your device make sure you have NodeJS Use this link to install NodeJS Use this link to install all the needed modules and create a React Application to see if eveerything works

1. Open cmd/ Git Bash
2. Go to the directory of the local repository on your device
3. Enter

4. It should open the local web page in your default browser (it is dynamic, so everytime you make a change you do not need to restart it, you make a change in code, it makes a change in web page) If not: open http://localhost:3000 to view it in the browser.

DO NOT MERGE YOUR BRANCH WITH THE MASTER BRANCH WITHOUT CHECKING IF YOUR BRANCH WORKS AND DISCUSSING IT WITH THE GROUP

1. Open Git Bash
2. Go to the directory of the local repository on your device
3. Enter

**Side note: if you get Error 126 when doing npm start enter

4. Enter

5. Enter

6. Enter

7. Enter

1. Open Git Bash
2. Go to the directory of the local repository on your device
3. Choose your branch
4. Change 'master' in package.json to the name of your branch in

...
"scripts": {
    ...
    "deploy": "gh-pages -b master -d build",
    ...
}    

5. Enter

6. Enter

7. Enter

8. Enter

9. Enter

10. Contact the creator of GitHub repository to change the settings to your branch