Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 1.89 KB

README.md

File metadata and controls

73 lines (48 loc) · 1.89 KB
Raw

Quick Notes

Deploy a full stack web app to help you organize your notes when you're on the go.

🛠 Built with React, GraphQL, AWS Amplify, AWS AppSync, Amazon Transcribe, & Amazon Polly

Features

  • 🎙 Record notes
  • 🔈 Play notes back
  • 📖 Read notes
  • 👮‍ Authenticated
  • 🔥 Serverless back end
  • 🚀 GraphQL
  • 💻 Deploy back end in minutes

Deploy the App

To automatically deploy the app, click the big orange button 👇

amplifybutton

If you wish to manually deploy the app, follow the instructions below.

Deploy the back end and run the app

  1. Clone the repo & install the dependencies
~ git clone https://github.com/kkemple/quick-notes.git
~ cd quick-notes
~ npm install
  1. Initialize and deploy the Amplify project
~ amplify init
? Enter a name for the environment: dev (or whatever you would like to call this env)
? Choose your default editor: <YOUR_EDITOR_OF_CHOICE>
? Do you want to use an AWS profile? Y

~ amplify push
? Are you sure you want to continue? Y
? Do you want to generate code for your newly created GraphQL API? N
> We already have the GraphQL code generated for this project, so generating it here is not necessary.
  1. Start the app and register a new user
~ yarn start

Deploy the front end

  1. Create a new repository with your git service of choice

  2. Push the project to your new repository

~ git remote add origin <your_new_repository>
~ git push --set-upstream master
  1. Connect to AWS Amplify Console and wait for build to start. You will be given a production URL and you are ready to take some notes!

License

This library is licensed under the MIT-0 License. See the LICENSE file.