-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f6c9b71
commit b16a746
Showing
1 changed file
with
54 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,57 @@ | ||
# React + Vite | ||
# Visual Tales 🎨📖 | ||
|
||
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. | ||
**Visual Tales** is a platform where users can express their creativity by posting images with titles and descriptions. Built using **React.js** and **Tailwind CSS** for the frontend and **Appwrite** as the backend, this application provides a seamless experience for users to **sign up**, **log in**, and share their visual stories. | ||
|
||
Currently, two official plugins are available: | ||
## Live Demo | ||
|
||
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh | ||
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh | ||
Check out the live demo of Visual Tales [here](https://visual-tales.vercel.app/). | ||
|
||
## Features | ||
|
||
- **User Authentication**: Sign up and log in to access the platform. | ||
- **Post Creation**: Users can post images along with titles and descriptions. | ||
- **Interactive Feed**: Browse through a feed of user-generated content. | ||
- **Responsive Design**: Built with Tailwind CSS for a modern look and feel. | ||
|
||
## Tech Stack | ||
|
||
- **Frontend**: React.js, Tailwind CSS | ||
- **Backend**: Appwrite | ||
- **Database**: Appwrite's built-in database | ||
|
||
## Installation | ||
|
||
To run this project locally, follow these steps: | ||
|
||
1. Clone the repository: | ||
|
||
```bash | ||
git clone https://github.com/naikmubashir/Visual-Tales.git | ||
cd Visual-Tales | ||
``` | ||
2. Install the required dependencies: | ||
|
||
```bash | ||
npm install | ||
``` | ||
3. Set up environment variables: | ||
|
||
Create a **`.env`** file in the root directory and add the following: | ||
|
||
```bash | ||
VITE_APPWRITE_URL=https://cloud.appwrite.io/v1 | ||
VITE_APPWRITE_PROJECT_ID=<your-appwrite-project-id> | ||
VITE_APPWRITE_DATABASE_ID=<your-database-id> | ||
VITE_APPWRITE_COLLECTION_ID=<your-collection-id> | ||
VITE_APPWRITE_BUCKET_ID=<your-bucket-id> | ||
VITE_API_KEY=<your-tinymc-api-key> | ||
``` | ||
4. Start the development server: | ||
|
||
```bash | ||
npm install | ||
``` | ||
5. Open the application in your browser at **`http://localhost:`** <port-number> | ||
|
||
|
||
|