Skip to content

Latest commit

 

History

History
89 lines (62 loc) · 2.73 KB

README.md

File metadata and controls

89 lines (62 loc) · 2.73 KB

Esy - Your Personal AI Essay Writer

Esy Logo

Overview

Esy is a premier SaaS provider in the EdTech sector, designed to revolutionize essay writing with advanced AI technology. Our platform serves as a personal AI essay writer, assisting users in crafting detailed, expressive, and high-quality essays with ease.

Features

  • AI-Powered Assistance: Utilize state-of-the-art AI to generate, refine, and enhance essays.
  • User-Friendly Interface: An intuitive design that simplifies the essay writing process.
  • Customization: Adapt the AI assistance to match various writing styles and requirements.
  • Real-Time Feedback: Receive instant feedback on grammar, style, and structure to improve writing quality.
  • Resource Integration: Access a variety of resources for research and reference with ease.

Getting Started

Prerequisites

  • Node.js (v14 or later)
  • npm package manager

Installation

  1. Clone the repository:

    git clone https://github.com/esywriter/esy.com.git
cd esy.com

  2. Install dependencies:

    npm install

  3. Run the development server:

    npm run develop

    Open http://localhost:8000 to view it in the browser.

Directory Structure

  • Root Directory: Configuration files and project metadata (e.g., README.md, package.json).

  • Netlify Functions: Serverless functions for Netlify integration.

  • Public: Public assets such as images and fonts.

  • Source Code (src): Main source code for the application.

    src
├── components   # Reusable UI components
├── config       # Configuration files
├── content      # Markdown files for content
├── data         # JSON data files
├── hooks        # Custom hooks
├── images       # Image assets
├── modules      # Feature modules
├── pages        # Gatsby pages
├── styles       # Global styles
├── svg          # SVG assets
├── templates    # Page templates
├── theme        # Theme configuration

Contributing

We welcome contributions from the community! Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature).
  3. Commit your changes (git commit -m 'Add your feature').
  4. Push to the branch (git push origin feature/your-feature).
  5. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For support or inquiries, please contact us at support@esy.com or visit our website.