Giter VIP home page Giter VIP logo

peachwww's Introduction

peachwww

This is the source code for peachwww.com, an unofficial web client for Peach.

Purpose

One of our goals for Peach is to be a great for developers. I'd like to make sure we do that by building on it myself.

This project will only ever use APIs and methods that 3rd party developers have access to. This makes us more sensitive to developers on Peach.

I'd like to ensure my needs align with the needs of Peach developers, which will help us to respond to them quickly and appropriately.

๐Ÿ‘


This project may be forked as the basis for an official client in the future, but right now we don't have the bandwidth to build or support one. So it's a personal project for now.

Status

Very early. Can't make too many promises about the quality of the code, but I'm trying!

Features

  • Mostly read-only right now. Account creation is not supported, and post types are about halfway there.

  • Automatically refreshes, so it's nice to leave open in a tab somewhere

  • Chat-ish interface

  • Use the L/R arrow keys to navigate through people

Other notes

  • We don't currently support 3rd party image uploading through our API, so all images posted through peachwww are uploaded to Imgur. Peach will open this soon, and then I'll make the change here, but for now: upload at your own risk!

Installation

$ npm install

Then create a .env file in the project directory and set these variables:

IMGUR_CLIENT_ID=XXX
EMBEDLY_API_KEY=XXX

Or if your environment has another way of setting process.env, do that. โšก๏ธ

Or if you don't need to support post creation, don't do anything. ๐Ÿ˜‹

Then:

$ npm start

TODO:

  • Sign up
  • Log in
  • View streams
  • Mark viewed streams as read
  • Render all post types
  • Likes
  • Leave and view comments
  • @mention autocompletion
  • View profiles
  • Edit profile
  • Activity
  • Add friends
  • Create text posts
  • Create image posts
  • Create gif posts
  • Create video posts
  • Create location posts

peachwww's People

Contributors

domhofmann avatar jiaaro avatar

Watchers

 avatar James Cloos avatar  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.