Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/shaqdeff/teache

A promotional page for Teache – an app that transforms the way we engage with education.
https://github.com/shaqdeff/teache

gsap react styled-components

Last synced: 17 days ago
JSON representation

A promotional page for Teache – an app that transforms the way we engage with education.

Awesome Lists containing this project

README

        

# Teache

## Built With

- React
- JavaScript
- Styled Components
- GSAP

## Live Demo

- Click [here](https://teachee.netlify.app/) to view the live demo.

## How To Use:

To get started, follow these simple steps:

### Prerequisites

Make sure you have node `16.0.0` or higher and npm `9.0.0` or higher installed.

### Setup

- With git, clone the code to your machine, or download a ZIP of all the files directly.
- [Download the ZIP file from this location](https://github.com/shaqdeff/Teache/archive/refs/heads/main.zip) or run the following [git](https://git-scm.com/) command to clone the files to your machine:

```
git clone https://github.com/shaqdeff/Teache.git
```

- Once the files are on your machine, open the **Next-Internalization** folder in [Visual Studio Code](https://code.visualstudio.com/download).

```
cd Teache && code .
```

## Install

- After opening the files in Visual Studio Code, open the **VS Code** integrated terminal and run the following commands:

```
npm install
```

This will install all the packages and dependencies used in the project.

## Usage

- Run the following command to start a local server:

```
npm start
```

This will open up the project on a browser on `http://localhost:3000`

## Build

- To create a production build:

```
npm run build
```

## Authors

👤 **Shaquille Ndunda**

- GitHub: [@shaqdeff](https://github.com/shaqdeff)
- Twitter: [@shaquillendunda](https://twitter.com/shaquillendunda)
- LinkedIn: [Shaquille Ndunda](https://www.linkedin.com/in/shaquille-ndunda)

## Show your support

Give a ⭐️ if you like this project!