Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rtarun3606k/walkez
https://github.com/rtarun3606k/walkez
azure css docker flask hacktoberfest hacktoberfest-accepted hacktoberfest2024 html5 js psql python react sqlalchemy yolov5
Last synced: 18 minutes ago
JSON representation
- Host: GitHub
- URL: https://github.com/rtarun3606k/walkez
- Owner: Rtarun3606k
- License: mit
- Created: 2024-09-14T10:26:47.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T09:58:30.000Z (11 days ago)
- Last Synced: 2024-11-09T02:02:48.385Z (about 1 hour ago)
- Topics: azure, css, docker, flask, hacktoberfest, hacktoberfest-accepted, hacktoberfest2024, html5, js, psql, python, react, sqlalchemy, yolov5
- Language: JavaScript
- Homepage: https://walkez.vercel.app
- Size: 8.71 MB
- Stars: 2
- Watchers: 1
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Walkez
This repository contains the code for the Walkez project.
## Overview
This project is built using [React](https://reactjs.org/) and [Vite](https://vitejs.dev/). Vite is a fast build tool that serves your code through a local server and provides hot module replacement.
## Getting Started
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
### 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:
```bash
git clone https://github.com/Rtarun3606k/Walkez.git
cd Start-up
cd frontend
```
2. Install dependencies:
```bash
npm install
# or
yarn install
```
### Running the Development Server
To start the development server, run:
```bash
npm run dev
# or
yarn dev
```
The app will be available at [http://localhost:3000](http://localhost:3000).
### Building for Production
To create a production build, run:
```bash
npm run build
# or
yarn build
```
The build artifacts will be stored in the `dist` directory.
### Linting
To lint the code, run:
```bash
npm run lint
# or
yarn lint
```
### Formatting
To format the code, run:
```bash
npm run format
# or
yarn format
```
## Learn More
To learn more about React and Vite, take a look at the following resources:
- [React Documentation](https://reactjs.org/)
- [Vite Documentation](https://vitejs.dev/)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
# Backend - Flask Application
This directory contains the backend code for the Start-up project, built using [Flask](https://flask.palletsprojects.com/).
## Getting Started
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
Ensure you have the following installed:
- Python (version 3.6 or higher)
### Installation
1. Clone the repository:
```bash
git clone https://github.com/Rtarun3606k/Start-up.git
cd Start-up
cd backend
```
2. Create a virtual environment:
```bash
python -m venv venv
```
3. Activate the virtual environment:
- On Windows:
```bash
venv\Scripts\activate
```
- On Unix or MacOS:
```bash
source venv/bin/activate
```
4. Install dependencies:
```bash
pip install -r requirements.txt
```
### Running the Application
To start the application, run:
```bash
python wsgi.py
```
The app will be available at [http://localhost:5000](http://localhost:5000).
## Learn More
To learn more about Flask, take a look at the following resources:
- [Flask Documentation](https://flask.palletsprojects.com/)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
```