Skip to content

Latest commit

 

History

History
133 lines (83 loc) · 3.46 KB

README.md

File metadata and controls

133 lines (83 loc) · 3.46 KB
Raw

Survey

This website allows to easy onboarding of sellers to watermelon marketplace

Table of Content

Description

This is a website that shows my portfolio/resume.It contains all my background information,some sample projects that I have worked on and the experience gained.

Installation

Requirements

  • Either a computer,phone,tablet or an Ipad

  • An access to the Internet

Installation Process

Frontend

Link

* Navigate to the project directory with the command `cd frontend`

* Navigate to the frontend directory with the command `cd watermelonfront`

* Install all the dependencies with the command `npm install`

* Start the app with the command `npm run dev`

* Navigate to the app on your browser with the url `http://localhost:****` where **** is the port number displayed on
your terminal eg 5174.

Backend

Link

Setup

Commandline commands

Powershell commands

cd .\backend
Bash Commands
cd ./backend

Install Python requirements and dependencies

pip install -r requirements.txt

Environment variables

 Create a .env file in the current directory with the following data format

e.g

DATABASE_TYPE=postgresql
DATABASE_NAME=mms_database
DATABASE_HOST=localhost
DATABASE_USERNAME=postgres
DATABASE_PASSWORD=admin

Start Server

Commandline commands

python app.py

To interact with the server locally, open the [link](http://127.0.0.1:8000) or paste http://127.0.0.1:8000
or http://localhost:8000
in the browser.

Go Back to the top

Technology Used

* Frontend: ViteJS, Tailwind css.Redux Toolkit
* Backend: FAST API, Sqlalchemy.
* Database: PostgreSQL

Reference

* Materialize CSS
* React Router
* ViteJS
* Tailwind
* FastAPI

Go Back to the top

Licence

MIT License

Copyright (c) [2023] [Albert Byrone]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Go Back to the top

Authors Info

Slack Profile - Albert Byrone

Linked - Albert Byrone

Go Back to the top