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.
| MVP Feature List | Database Schema | API Documentation | Frontend Routes |
-
Clone this repo.
git clone [email protected]:katsutori/chonkr.git
-
Install dependencies from the root directory.
npm install
-
Create a POSTGRESQL user with CREATEDB and PASSWORD in PSQL.
CREATE USER <name> WITH CREATEDB PASSWORD <'password'>
-
Create a .env file in the backend directory based on the .env.example found within the respective directory.
-
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).
-
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"
-
Create Database, Migrate, and Seed models.
npx dotenv sequelize db:create
npx dotenv sequelize db:migrate
npx dotenv sequelize db:seed:all
-
Start the services in the backend directory.
npm start
-
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
-
You can use the Demo user or create an account to begin using Chonkr.
Logged in users can perform the following actions.
- Add/View/Edit/Delete Photos
- Add/View/Edit/Delete Albums