Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/malcodeman/polaroid-client

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/malcodeman/polaroid-client
Owner: malcodeman
License: mit
Created: 2018-04-26T20:30:46.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2023-01-04T03:06:51.000Z (about 2 years ago)
Last Synced: 2024-10-29T11:10:32.297Z (2 months ago)
Language: JavaScript
Size: 6.3 MB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 24
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

my-awesome-repos - polaroid-client - Polaroid is small, lean and pretty ✨ project-based-learning result heavily inspired by Instagram. (React)

README

        # Polaroid client

[![style: styled-components](https://img.shields.io/badge/style-%F0%9F%92%85%20styled--components-orange.svg?colorB=daa357&colorA=db748e)](https://github.com/styled-components/styled-components)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![Cypress.io tests](https://img.shields.io/badge/cypress.io-tests-green.svg?style=flat-square)](https://cypress.io)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/malcodeman/polaroid-client/blob/master/LICENSE)

[![jest](https://jestjs.io/img/jest-badge.svg)](https://github.com/facebook/jest)

Polaroid is small, lean and pretty ✨ project-based-learning result heavily inspired by Instagram.

![Screenshot](docs/images/screenshot.jpg)

## Getting started

First, clone and run the api:

```

git clone https://github.com/malcodeman/polaroid-server.git polaroid-server

cd polaroid-server

yarn install && yarn start

```

Next, you can clone and run the frontend:

```

git clone https://github.com/malcodeman/polaroid-client.git polaroid-client

cd polaroid-client

yarn install && yarn start

```

.env.development.local:

```

REACT_APP_API_URL = "http://localhost:9001/api/"

```

## Design decisions

Why ... ?

- [formik](https://github.com/reduxjs/redux/issues/1287#issuecomment-175351978)

- [date-fns](https://github.com/date-fns/date-fns/issues/275#issuecomment-264934189)

- [redux-saga](https://stackoverflow.com/questions/34930735/pros-cons-of-using-redux-saga-with-es6-generators-vs-redux-thunk-with-es2017-asy/34933395#34933395)

## Credits

Huge ❤️ to:

- [Dan Abramov](https://github.com/gaearon)

- [Jared Palmer](https://github.com/jaredpalmer)

- [Federico Zivolo](https://github.com/FezVrasta)

- [Yassine Elouafi](https://github.com/yelouafi)

## Todos

- Upload photo or add photo from web option for new posts

- Preview image before upload

- Two-factor authentication

- Languages

- Active Sessions with browser, location and last seen information

- Delete account option

- Temporarily disable account option

- Account data download

- Search

- Explore

- Notifications for likes and comments

- Advertising

- Post options like share, report, embed, copy link, go to post

- Post page

- Suggested people page

- Your likes page

- Post caption

- Comments pagination

- Favicon

- Block user option

- CI/CD

- Improved loading state

## License

[MIT](./LICENSE)