Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sujal-goswami/unscripted
Unscripted is a blog app with user authentication, rich text editing, and a modern UI using React, Appwrite, TinyMCE, and Redux.
https://github.com/sujal-goswami/unscripted
appwrite node-js reactjs redux-toolkit tailwindcss tinymce
Last synced: 10 days ago
JSON representation
Unscripted is a blog app with user authentication, rich text editing, and a modern UI using React, Appwrite, TinyMCE, and Redux.
- Host: GitHub
- URL: https://github.com/sujal-goswami/unscripted
- Owner: sujal-goswami
- License: mit
- Created: 2024-02-22T20:52:31.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-08-26T12:58:12.000Z (2 months ago)
- Last Synced: 2024-10-12T17:03:28.674Z (24 days ago)
- Topics: appwrite, node-js, reactjs, redux-toolkit, tailwindcss, tinymce
- Language: JavaScript
- Homepage: https://unscripted.pages.dev/
- Size: 155 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Unscripted
Unscripted is a modern blog web application that provides users with all the essential features of a blog. Built with a robust and scalable tech stack, Unscripted offers a seamless writing and reading experience.
## Features
- **User Authentication:** Secure user authentication and authorization using Appwrite.
- **Rich Text Editing:** Utilize TinyMCE for a powerful and intuitive rich text editor.
- **Blog Creation & Management:** Create, edit, and delete blog posts with ease.
- **Responsive Design:** Fully responsive UI built with React, providing an optimal experience across all devices.
- **State Management:** Efficient state management using Redux.
- **Drafts & Publishing:** Save drafts and publish posts at your convenience.
- **User Profiles:** Manage your profile and view other users' profiles.
- **Appwrite Integration:** Backend powered by Appwrite for database, authentication, and more.
## Tech Stack
- **Frontend:** React-js, TinyMCE, Redux
- **Backend:** Appwrite
- **Styling:** HTML, CSS, Tailwind CSS
- **State Management:** Redux
## Getting Started
### Prerequisites
- Node.js (v20.x or later)
- npm or yarn
- Appwrite instance (cloud or self-hosted)
### Installation
1. **Clone the repository:**
```bash
git clone https://github.com/sujal-goswami/Unscripted.git
cd Unscripted
```
2. **Install dependencies:**
```bash
npm install
```
3. **Set up Appwrite:**
- Create an account on Appwrite or set up your own Appwrite instance.
- Create a new project in Appwrite.
- Set up authentication and database collections as needed.
- Update the Appwrite configuration in the `.env` file using `.env.sample`.
4. **Run the application:**
```bash
npm start
```
The application should now be running at `http://localhost:5173`.
## Contributing
Contributions are welcome! If you'd like to contribute to Unscripted, please fork the repository, create a new branch, and submit a pull request.
## License
This project is licensed under the MIT License - see the LICENSE file for details.