Walkez is a community-driven platform for efficient complaint tracking and resolution, integrating real-time updates, user engagement, and data analytics to improve accountability and impact.
This project is built using React and Vite. Vite is a fast build tool that serves your code through a local server and provides hot module replacement.
Ensure you have the following installed:
- Node.js (version 14.0.0 or higher recommended)
- npm (version 6.0.0 or higher recommended) or yarn
-
Clone the repository:
git clone https://github.com/Rtarun3606k/Walkez.git cd Walkez cd frontend
-
Install dependencies:
npm install # or yarn install
To start the development server, run:
npm run dev
# or
yarn dev
The app will be available at http://localhost:3000.
To create a production build, run:
npm run build
# or
yarn build
The build artifacts will be stored in the dist
directory.
To lint the code, run:
npm run lint
# or
yarn lint
To format the code, run:
npm run format
# or
yarn format
To run the docker for the project (only frontend)
- First change the directory to the
frontend
cd frontend
- Build the docker image:
docker build -t walkez-image:1.0 .
- Run the container:
docker run -d -p 3000:80 --name walkez-app walkez-image:1.0
Ensure you have the following installed:
- Python (version 3.6 or higher)
-
Clone the repository:
git clone https://github.com/Rtarun3606k/Walkez.git cd Walkez cd backend
-
Create a virtual environment:
python -m venv venv
-
Activate the virtual environment:
- On Windows:
venv\Scripts\activate
- On Unix or MacOS:
source venv/bin/activate
- On Windows:
-
Install dependencies:
pip install -r requirements.txt
To start the application, run:
python wsgi.py
The app will be available at http://localhost:5000.
To learn more about Flask, React and Vite take a look at the following resources:
This project is licensed under the MIT License - see the LICENSE file for details.