Git Product home page Git Product logo

chirp-2's Introduction

Chirp (2.0)

Next JS React TypeScript Prisma TailwindCSS

From breaking news to shitposts, get the latest information from people all over the world with this next-generation blazingly-fast social media app!

Features

  • Create, edit, and delete chirps (posts)
  • Like and unlike chirps
  • User authentication and profiles
  • Follow and unfollow users
  • View posts from followed users
  • Search for users and posts
  • Chirp Purple

The Stack

  • Next.js - Fullstack React framework ๐Ÿš€๐Ÿ’ช
  • Prisma - Database without the tears ๐Ÿ˜ญ
  • tRPC - Typescript RPC framework ๐Ÿฆ‰
  • Tailwind CSS - CSS framework ๐ŸŽจ
  • MySQL - Database ๐Ÿ—ƒ๏ธ

Hosted on

  • Vercel - Frontend hosting โ–ฒ (they're awesome for sponsoring TechCodes)
  • PlanetScale - Vitess MySQL Database hosting ๐Ÿ—„๏ธ (they're awesome too)

Developing

Overview of the Folder Structure

Extending https://create.t3.gg/en/folder-structure src/components/[division]/[component-name].tsx - Contains reusable UI code for chirps, users, layout, or general UI stuff. src/lib/** - Contains reusable code appropriate for other projects.

Running The Easy Way

  1. Load the devcontainer defined in .devcontainer/devcontainer.json
  2. Create a .env.local file with the appropriate environment variables (see .env.example)
  3. Run the development task in VSCode

Running The Harder Way

Required tools (these are my versions, the app may or may not work on other versions):

  • node v19.9.0
  • yarn 1.22.19
  • docker 20.10.24

Steps:

  1. Create a .env.local file with the appropriate environment variables (see .env.example)
  2. Install dependencies: yarn
  3. Start MySQL service: docker compose up
  4. Set up the database: yarn prisma db push
  5. Start the app: yarn dev
  6. If everything went right, you should be able to access the app at http://localhost:3000

License

Distributed under the MIT License. See LICENSE for more information.

chirp-2's People

Contributors

giilbert avatar

Stargazers

 avatar

Watchers

 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.