A social media platform to share photos of your moments
View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

pik is a photo sharing social networking service. It provides a platform for users to share their photos and gives a summary of their posts based on certain categories such as people, food, etc.

Built With

• React
• Redux
• Node.js
• Mongoose
• Express
• MongoDB
• AWS S3
• Google OAuth 2.0
• Google Cloud Vision API
• Material UI
• Heroku

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• yarn

brew install yarn

Installation

1. Clone the repo

git clone https://github.com/yehee/pik.git

2. Install NPM packages

cd pik
yarn

3. Create build distribution

cd client
yarn build

4. Start the app!

cd ../api
npm start

The app should be accessible at http://localhost:8080

Environment Variables

api/db/.env for database credentials:

DB_USER=
DB_PASS=
DB_NAME=

./api/init/.env.local for Google OAuth credentials:

OAUTH_CLIENT_ID=
OAUTH_CLIENT_SECRET=

./api/controllers/.env.local for AWS credentials:

ACCESS_KEY_ID=
SECRET_KEY=

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

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

Contact

Alice Kim

• 💼 LinkedIn: https://linkedin.com/in/yehee
• 🎒 Website: https://yehee.github.io
• 📫 [email protected]

Hyunuk Lim

• 💼 LinkedIn: https://linkedin.com/in/hyunuk
• 🎒 Website: https://hyunuk.github.io
• 📫 [email protected]

Project Link: https://github.com/yehee/pik