README.md

A minimalist haiku creating and sharing social app

Provoking creativity and connecting creators. Users create haikus according to the 5/7/5 syllable count and publish for the world to see.

Collect Haikus

Users can collect haikus from other users to add to their collection. The limit for collection is 1 haiku per 24 hours. Your collection should represent your absolute favorites!

Connecting Illustrators with Authors

Users can submit haikus from their collection to our platform sponsored artist/illustrators for review. If accepted, the illustrator will create a rendering of their own visual interpretation of the haiku and featured in the app-wide gallery for viewing.

Getting started

You need these things to run the Oku app. Follow the instructions supplied below or on their links before you continue with Installation.

• Wordnik. Get API key here
• Neo4j local database, including the Neo4j Desktop App. Download and install from here

Installation

1. Clone this repo and enter

   git clone https://github.com/aaronzomback/oku.git
   cd oku

2. Install dependencies, by running npm install both in the client and the server folder

3. Add API keys as listed in the .env.example file.

4. Start the server by running nodemon in the server folder.

5. Create a database called "oku" with Neo4j Desktop.

6. For a better experience, you might want to populate your DB with mock data. To do so follow these steps:

   • In the server folder, find the "mock_data" folder
   • Open your psql CLI, paste and run the entire content of Logins.sql, Users.sql, Products.sql.
   • In server/index.js uncomment line 9 ("const populate = ...") and restart the server. Comment it back out.
   • Do the same for line 10.

7. In the client folder, run npm start to start the development server.

Tech Stack

React-Native, GraphQL, Apollo, Neo4j, NodeJS.