Skip to content

Commit

Permalink
update: add badges, add some basic description, and project vision
Browse files Browse the repository at this point in the history
  • Loading branch information
brueningf committed Jan 17, 2025
1 parent 01e7186 commit 5675f1e
Showing 1 changed file with 35 additions and 10 deletions.
45 changes: 35 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,44 @@
[![Netlify Status](https://api.netlify.com/api/v1/badges/3377cddb-b7fb-403f-b5bc-ec1bbc0f051a/deploy-status)](https://app.netlify.com/sites/a-brightpath/deploys)
![Frontend](https://github.com/chingu-voyages/V53-tier3-team-35/actions/workflows/frontend-tests.yml/badge.svg)
![Backend](https://github.com/chingu-voyages/V53-tier3-team-35/actions/workflows/backend-tests.yml/badge.svg)

# voyage-tasks
# BrightPath Online Course Platform
**Created by the Go Getters**

Your project's `readme` is as important to success as your code. For
this reason you should put as much care into its creation and maintenance
as you would any other component of the application.
## Project Vision Statement
During this six-week Chingu voyage, our team will design, develop, and launch BrightPath, a custom platform for online courses that will cover niche tech topics not currently addressed elsewhere.
All courses—including videos, readings, activities, and quizzes—will be freely available to the public. Users can log in to access course content and track their progress.
Upon completing all required lessons and assessments for a given course, users will be issued a verified BrightPath certificate that can be shared on LinkedIn and other web platforms to demonstrate their achievement.
Our practical, project-based courses will help learners stay at the forefront of the ever-evolving tech landscape.

If you are unsure of what should go into the `readme` let this article,
written by an experienced Chingu, be your starting point -
[Keys to a well written README](https://tinyurl.com/yk3wubft).
---

And before we go there's "one more thing"! Once you decide what to include
in your `readme` feel free to replace the text we've provided here.
## Primary Links
- **Frontend**: [BrightPath Frontend](https://a-brightpath.netlify.app/)
- **Backend**: [BrightPath Backend](https://brightpath-api.up.railway.app/)

> Own it & Make it your Own!
---

## About the Project
BrightPath is built to offer free, project-based learning experiences. Users will find interactive content, gain hands-on skills, and earn verifiable certificates that showcase their achievements.

### Features
- **Free, Public Access**: Courses are freely accessible to all users.
- **Personalized Learning**: Login functionality enables users to track their progress.
- **Certificates of Completion**: Highlight learning accomplishments on LinkedIn or other platforms.
- **Rich Content**: Courses include videos, readings, activities, and assessments.

---

## Tech Stack
- **Frontend**: Next.js (hosted on Netlify)
- **Backend**: Express.js (hosted on Railway)
- **Database**: PostgreSQL
- **Other**: OAuth Authentication

---

We invite you to explore the platform and join us in shaping the future of online learning! 🎓✨

## Team Documents

Expand Down

0 comments on commit 5675f1e

Please sign in to comment.