Giter Club home page Giter Club logo

chonkr's Introduction

Chonkr

This is a chonky clone of Flickr. Access the Chonkr MVP.

Chonkr is the place to go to share your photos of preciously plump animals.

Index

| MVP Feature List | Database Schema | API Documentation | Frontend Routes |

Technologies Used

Getting started

  1. Clone this repo.

  2. Install dependencies from the root directory.

    • npm install
  3. Create a POSTGRESQL user with CREATEDB and PASSWORD in PSQL.

    • CREATE USER <name> WITH CREATEDB PASSWORD <'password'>
  4. Create a .env file in the backend directory based on the .env.example found within the respective directory.

  5. Enter your username and password information into your .env file along with your desired database name, a secured combination of characters for your JWT_SECRET, and your desired PORT (preferably 5000).

  6. Add the following proxy to your package.json file within your frontend directory, replacing or keeping the 5000 port to match your PORT configuration found in your .env file.

    • "proxy": "http://localhost:5000"
  7. Create Database, Migrate, and Seed models.

    • npx dotenv sequelize db:create
    • npx dotenv sequelize db:migrate
    • npx dotenv sequelize db:seed:all
  8. Start the services in the backend directory.

    • npm start
  9. Start the services in the frontend directory, which should open the project in your default browser. If not, navigate to http://localhost:3000.

    • npm start
  10. You can use the Demo user or create an account to begin using Chonkr.

Features

Logged in users can perform the following actions.

  • Add/View/Edit/Delete Photos
  • Add/View/Edit/Delete Albums

chonkr's People

Contributors

katsutori avatar

Stargazers

Adam Tang 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.