Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chingu-voyages/upskill

A Full-stack Skill Sharing Site: a team project built according to agile methodology
https://github.com/chingu-voyages/upskill

agile-development express nodejs postgresql react redux social-network supabase tailwindcss teamwork

Last synced: 3 months ago
JSON representation

A Full-stack Skill Sharing Site: a team project built according to agile methodology

Awesome Lists containing this project

README

        


logo

Empowering Individuals, Building Communities





View Demo *


*Note: Our backend server is running on a free tier, which means after 20 minutes of inactivity it spins down. So, please be patient, starting from cold the server can take around 20 seconds to start up and respond.


# :notebook_with_decorative_cover: Table of Contents

- [About the Project](#star2-about-the-project)
* [Tech Stack](#space_invader-tech-stack)
* [Features](#dart-features)
* [Color Reference](#art-color-reference)
* [Environment Variables](#key-environment-variables)
- [Getting Started](#toolbox-getting-started)
* [Prerequisites](#bangbang-prerequisites)
* [Installation](#gear-installation)
* [Run Locally](#running-run-locally)
- [Contributing](#wave-contributing)
- [Contact](#handshake-contact)
- [Acknowledgements](#gem-acknowledgements)

## :star2: About the Project


screenshot

### What is UpSkill?
A social platform designed to bring people together and forge communities based around co-working, co-learning and skill sharing. In our first iteration we have delivered an MVP to enable people to meet others from across the world, message and connect, share skills, teach and learn. Beyond the scope of our MVP is an aim to build a fully integrated skills sharing ecosystem with tokenised lessons, where people can trade their skills for tokens they can exchange elsewhere on the site to expand their own skills.

### :space_invader: Tech Stack

Client

Server

Database

### :dart: Features

- Search and browse for mentors
- Ability to create/update account
- Messaging capability
- Scheduling sessions via Calendly

### :art: Color Reference

| Color | Hex |
| ----------------- | ------------------------------------------------------------------ |
| Primary Color | ![#265B8B](https://via.placeholder.com/10/265B8B?text=+) #265B8B |
| Secondary Color | ![#1181C8](https://via.placeholder.com/10/1181C8?text=+) #1181C8 |
| Accent Color | ![#84C7F2](https://via.placeholder.com/10/84C7F2?text=+) #84C7F2 |
| Text Color | ![#23445B](https://via.placeholder.com/10/23445B?text=+) #23445B |
| Background Color | ![#ECECEB](https://via.placeholder.com/10/ECECEB?text=+) #ECECEB |

### :key: Environment Variables

To run this project, you will need to add the following environment variables to your .env file

`API_KEY`

`ANOTHER_API_KEY`

## :toolbox: Getting Started

### :bangbang: Prerequisites

This project uses NPM as package manager

```bash
npm install
```

### :gear: Installation

Install my-project with npm

```bash
npm install
```

### :running: Run Locally

Clone the project

```bash
git clone https://github.com/chingu-voyages/UpSkill.git
```

Go to the client directory
```bash
cd client
npm install
npm run dev
```

Go to the server directory
```bash
cd server
npm install
node index
```

## :wave: Contributing



Go Chingu Bears 29!

## :handshake: Contact

## Pictured from 👈 Left to Right 👉
- [Mark](https://github.com/marksist300)
- [Mario](https://github.com/manzcode)
- [Michael](https://github.com/mikeyxx)
- [Dana](https://github.com/Dnhem)
- [Jim](https://github.com/jdmedlock)

Project Link: [N/A]([https://github.com/Louis3797/awesome-readme-template](https://www.chingu.io/))

## :gem: Acknowledgements

Thank you to Jim and the [Chingu](https://www.chingu.io/) team for helping us Upskill!