freeWriter

freeWriter is an innovative storytelling and writing assistance tool designed to help aspiring writers create and develop their stories.

Features (MVP)

• User Authentication
• Story Management
• Writing Workspace
• AI Assistance
• Card System
• Basic Sketch Generator

Prerequisites

• Node.js (v14 or later)
• npm or yarn

Installation

1. Clone the repository:

   git clone https://gitlab.com/VyuduInc/freewriter
   cd freewriter
   

2. Install frontend dependencies:

   cd frontend
   npm install (if error, try npm i --force)
   

3. Set up environment variables:

   • Copy frontend/.env.example to frontend/.env
   • Fill in the required environment variables

4. Start the development server:

   cd frontend
   npm run dev
   

Running Tests

cd frontend
npm test

E2E Tests

cd frontend
npm run e2e

Deployment

For deployment instructions, please refer to the Deployment Guide.

Documentation

• User Guide
• API Documentation

Contributing

Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.