Frontend for Chirp: A Twitter clone

We created Chirp, a very simple copy of Twitter to learn about Agile Process Management, Collaboration, Web Technologies and Relational Databases. This repository contains the frontend code for Chirp.

Open App Backend Repository Swagger Docs

Bildschirmfoto 2023-05-03 um 18 44 31

The frontend is built on React and continuously deployed on Netlify.

The backend repository can be found here

Getting Started

To get started with Chirp, clone this repository to your local machine and follow the instructions provided below.

Prerequisites

Before you begin, ensure that you have the following installed on your machine:

Installation

  1. Clone the repository:

git clone https://github.com/TobiasAschenbrenner/twitter-clone-frontend.git

  1. Install dependencies:

npm install

Running the Application

  1. Start the development server:

npm start

  1. Open your browser and navigate to http://localhost:3000.

You should now see the Chirp Login Page!

Bildschirmfoto 2023-05-03 um 18 44 57

Deployment

To create a production build, run the following command:

npm run build

This command will generate a build directory with the optimized production build. For deployment instructions specific to your preferred platform, please refer to their respective documentation.

Project Architecture

Diagram of Project Architecture

Contributing

We welcome contributions to Chirp! To contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch with a descriptive name.
  3. Commit your changes.
  4. Push the branch.
  5. Open a Pull Request against the main branch.

Team

We are software engineering students at the CODE University of Applied Sciences in Berlin.

Tobias Aschenbrenner
Florian König
Benedict Löffler