Turn authentic user experiences into seamless content that allows users to connect and easily tell their stories
- Ant Design
- Express
- Node.js
- Passport
- PostgreSQL
- React
- Redux
- (a full list of dependencies can be found in
package.json) - AWS (S3 Buckets)
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Before you get started, make sure you have the following software installed on your computer:
Steps to get the development environment running:
- Fork and clone this repository.
npm install
npm run server
npm run client-
Set up a PostgreSQL database using the project's database.sql file.
-
Set up an AWS Bucket. Free, but will require a credit card. Helpful Guide: https://medium.com/@fabianopb/upload-files-with-node-and-react-to-aws-s3-in-3-steps-fdaa8581f2bd Create an .env file and paste this information from your AWS account: S3_BUCKET=(INSERT AWS INFO HERE) AWS_ACCESS_KEY_ID=(INSERT AWS INFO HERE) AWS_SECRET_ACCESS_KEY=(INSERT AWS INFO HERE)
Additional features to be implemented in the future:
- Share a story
- Create a template functionality
- Allow users to click on other users profiles
- Create a team functionality
- Incorporate teams throughout the app
- Allow users to click on other users profiles
- Add the like button to chapters
- Create multiple images/captions for chapters
- Allow the users to upload video
- Password reset feature
- Let the user request to be a contributor
Add additional notes about how to deploy this on a live system
- Anthony Dunahee
- Dion Roloff
- James Tucker
- Kye Berkeland
- Matt Kleven
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.