/write-right

This project is a web application for correcting English texts.

Primary LanguageSvelte

Write right principal page

This project is a web application for correcting English texts.

Astro Badge Svelte Badge GitHub stars GitHub forks GitHub PRs GitHub issues

🛠️ Stack

  • Astro
  • Svelte
  • Cohere
  • Tailwind

🚀 Getting Started

Note

This app only can be used in local.

  1. Clone the repository: git clone https://github.com/DPG-Code/write-right.git
  2. Install dependencies: npm install
  3. Set enviroment variables
  4. Start the development server: npm run dev
  5. Open your browser and navigate to http://localhost:3000
Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:3000
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying
npm run astro ... Run CLI commands like astro add, astro check
npm run astro --help Get help using the Astro CLI

Contributing

If you would like to contribute to this project, please follow these steps:

  1. Fork the repository
  2. Create a new branch: git checkout -b new-feature
  3. Make your changes and commit them: git commit -m "Add new feature"
  4. Push to the branch: git push origin new-feature
  5. Submit a pull request