Skip to content

stefkudla/brainWave-2

Repository files navigation

LinkedIn


Logo

brainWave

brainWave is a learning platform where users can create an account and have access to mock courses. brainWave also features mock blog posts that users can read.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project 1
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. Contact

About The Project

Product Name Screen Shot

This is a personal project that I had and continue to have lots of fun working on. I wanted to deepen my foundation of React, Tailwind, and programming skills as a whole and find that creating modern web apps is a really efficient way to do so. Thank you for checking it out!

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo
    git clone https://github.com/stefkudla/brainWave-2/
  2. Install NPM packages
    npm install

(back to top)

Roadmap

  • Build the UI with React and TailwindCSS, referencing the Figma Design
  • Implement React Router V6 to navigate around the different pages and blog posts
  • Implement user authentication with Firebase
  • Create Course Dashboard

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

(back to top)

Contact

Stefan Kudla - LinkedIn - stefan@stefankudla.com

Project Link: https://github.com/stefkudla/brainWave-2

(back to top)

(back to top)

About

brainWave is a React Application styled with TailwindCSS

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published