Skip to content

BaTaTaAdb/sopa-de-letras

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Word Search

Developed by João Nuno and Pedro Elias. To easily access our word search, play on the website https://batataadb.github.io/sopa-de-letras/. If you want to run the game locally, follow the instructions presented here.

Installation Instructions

Prerequisites

Make sure you have Node.js, npm, and python installed on your machine.

  1. Clone the Repository:
git clone https://github.com/BaTaTaAdb/sopa-de-letras.git
cd sopa-de-letras
  1. Dependency Installation: Go to the frontend directory and execute the following command to install the dependencies present in package.json:
cd frontend
npm install
  1. Backend Configuration: (Make sure you have all the necessary packages to run Flask)
# Access the backend directory and execute (instructions for Linux)
cd backend
python -m venv venv

.\venv\Scripts\activate.bat
python -m pip install -r requirements.txt
  1. Application Execution:
  • Start the backend (Flask):
cd backend
python app.py (start Flask) # Starts the server in development version
  • Then, start the frontend (React):
cd frontend
npm install
npm start # Starts the server in development version
  • OR Build the frontend (React):
npm run build
npm install -g serve
serve -s build # Serves the server already in its production version
  • Use a WSGI server for the backend (Unicorn):
gunicorn -w 4 -b 0.0.0.0:25590 app:app

After completing these steps, the application should be running in your local environment!

License

This project is licensed under the MIT license - see the LICENSE file for more details.


Technologies Used

Frontend:

Backend: