roughdraft

Write smarter & faster with AI
Roughdraft is an AI writing assistant that learns about your topic & writing style.
View Live Beta

Table of Contents

• About the Project
  • Built With
  • Backend
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Contact

About The Project

Roughdraft is an AI writing assistant that learns about your topic & writing style. It uses GPT-2 under the hood (If you have GPT-3 access and would like to contribute to this project, let me know!)

Although Roughdraft is open-source, we offer model training and hosting services for a monthly fee. See roughdraft.ai.

Built With

• React
• React Router
• Evergreen UI by Segment
• styled-components
• AWS Amplify SDK

Backend (not featured in this repo)

• RunwayML
• Amazon Cognito
• Amazon DynamoDB

Getting Started

If you would like to run this locally, be advised that the backend code is not public at this time (although it will be soon).

Prerequisites

• yarn
• AWS CLI

Installation

1. Install packages

yarn install

2. Configure AWS secrets

amplify init
amplify add auth
amplify add hosting

3. Configure DynamoDB REST API: Instructions available soon
4. Start the frontend on localhost

yarn start

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated, however because I am charging active users for use of the prod environment (master branch), you may wish to fork it instead. If you are excited about this project, contact me and consider joining as a co-founder!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @sambwinslow - samwinslow at nyu . edu

Project Link: https://github.com/samwinslow/roughdraft-ai