Giter VIP home page Giter VIP logo

chirp's Introduction

Chirp

Chirp logo

Chirp is an open source social media project designed to replicate the feel of Twitter, but be better. Chirp is built with PHP, HTML, JavaScript, CSS, and SQLite.

Status

What's Working

  • Account creation
  • Posting
  • Replying
  • Liking
  • Account editing
  • Following

What's Not Working

  • Reposts
  • Viewing reposts on accounts

What's Planned

  • Post editing
  • Post deletion
  • Search
  • Trends
  • "For You" timeline

Screenshot

Chirp on Desktop

Contributing to Chirp

Chirp's source code is open source, and contributions are welcome! You can fork this repository, make changes, and submit a pull request. If you contribute, include your Chirp username to receive a contributor badge next to your name.

Working with the Code

Using PHP's Built-in Server

  1. Clone this repository to your desired location.

  2. Navigate to the project directory:

    php -S localhost:port

Using Apache/XAMPP

  1. Ensure you have PHP and PDO with SQLite support installed.

  2. Clone the repository:

    git clone https://github.com/actuallyaridan/chirp
    mv chirp /var/www/
    • Note: Replace /var/www/ with the directory used by your Apache or XAMPP installation.
  3. Ensure the directory is empty before moving Chirp. Placing it in a non-empty folder like /htdocs/chirp may cause issues.

Database

Chirp uses SQLite as its database. The actual database is not included in the repository due to sensitive information, but a blank sample database (chirp.db.sample) is provided.

To use it:

  1. Rename chirp.db.sample to chirp.db.
  2. Place it above the root directory of your PHP web server to secure it.
  3. Data will populate automatically as you use the application.

To create an admin account:

  1. Manually generate an invite code.
  2. Sign up with the username "chirp".

Note: A more user-friendly system for managing permissions and privileges is planned.

Forking Chirp

You are free to fork Chirp and use its code as a foundation for your project. However, please adhere to the following guidelines:

  • Rebrand your project: Avoid using any Chirp branding.
  • Credit us: Provide credit to the original contributors or link to this repository.

Chirp is licensed under the MIT license.

chirp's People

Contributors

actuallyaridan avatar boochysans avatar parpok avatar pinball3d avatar dexrnzacattack avatar justnotsebas avatar timi2506 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.