README.md

Uplift

Uplift is a web application where you can tell a story and uplift others.

View Demo · Documentation · Report Bug · Request Feature

📔 Table of Contents

• 📔 Table of Contents
  • 🌟 About the Project
    • 📷 Screenshots / Gifs
    • 👾 Tech Stack
    • 🎯 Features
    • 🎨 Color Reference
  • 🚀 Getting Started
    • ❗ Prerequisites
    • ⚙️ Installation
    • 🧪 Running Tests
    • 🏃 Run Locally
    • 🚩 Deployment
  • ⏰ Roadmap
  • 👋 Contributing
  • ⚠️ License
  • 🤝 Contact

🌟 About the Project

📷 Screenshots / Gifs

👾 Tech Stack

Client

• Javascript
• React.js
• Chakra-ui.

Server

• Python
• FastAPI

Database

• Sqlite
• Sqlalchemy

🎯 Features

• Read uplifts
• Craete an uplift
• Authenictication *Coming soon
• Profile *Coming soon

🎨 Color Reference

Color	Hex
Primary Color	#e2e8f0
Secondary Color	#EEEEEE
Accent Color	#02054B
Text Color	#4A5568

🚀 Getting Started

❗ Prerequisites

This project uses Npm as package manager

curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.1/install.sh | bash

⚙️ Installation

Install uplift with npm

# Frontend installation
  cd uplift/frontend
   npm i

🧪 Running Tests

To run tests, run the following command

  npm test

🏃 Run Locally

Clone the project

  git clone https://github.com/Tobias2023/task-note.git

Go to the project directory

  cd uplift

Install dependencies

  npm install

Start the server

  npm start

🚩 Deployment

To deploy this project run

  npm deploy

⏰ Roadmap

• Add FE UI
• Add Testing (Pytest and Jest)
• Add User Authentication
• Add User Profiles
• Pass all test
• Deployment

👋 Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

⚠️ License

Distributed under the no License. See LICENSE.txt for more information.

🤝 Contact

Name - @TobiasCodes12

Project Link: https://github.com/Tobias2023/uplift