Skip to content

Hacker-smkg/Walkez

 
 

Repository files navigation

WALKEZ


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.

Overview

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.

Table of Content


Frontend

Prerequisites

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

Installation

  1. Clone the repository:

    git clone https://github.com/Rtarun3606k/Walkez.git
    cd Walkez
    cd frontend
  2. Install dependencies:

    npm install
    # or
    yarn install

Running the Development Server

To start the development server, run:

npm run dev
# or
yarn dev

The app will be available at http://localhost:3000.

Building for Production

To create a production build, run:

npm run build
# or
yarn build

The build artifacts will be stored in the dist directory.

Linting

To lint the code, run:

npm run lint
# or
yarn lint

Formatting

To format the code, run:

npm run format
# or
yarn format

Docker Setup

To run the docker for the project (only frontend)

  1. First change the directory to the frontend
 cd frontend
  1. Build the docker image:
  docker build -t walkez-image:1.0  .
  1. Run the container:
  docker run -d -p 3000:80 --name walkez-app  walkez-image:1.0

Backend - Flask Application

Prerequisites

Ensure you have the following installed:

  • Python (version 3.6 or higher)

Installation

  1. Clone the repository:

    git clone https://github.com/Rtarun3606k/Walkez.git
    cd Walkez
    cd backend
  2. Create a virtual environment:

    python -m venv venv
  3. Activate the virtual environment:

    • On Windows:
      venv\Scripts\activate
    • On Unix or MacOS:
      source venv/bin/activate
  4. Install dependencies:

    pip install -r requirements.txt

Running the Application

To start the application, run:

python wsgi.py

The app will be available at http://localhost:5000.


Learn More

To learn more about Flask, React and Vite take a look at the following resources:


License

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

About

SWOC

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 39.3%
  • CSS 25.9%
  • Python 20.9%
  • HTML 13.7%
  • Dockerfile 0.2%