A simple web-based platform where users can easily create, explore, and share Tailwind CSS components and designs with fellow users.
Make sure you star the repository and show your love to us💗
Contributing in open source increases your opportunities to work with different projects and mentors, getting to know various insights and ideas. It is a platform where contributors grow together with a construvtive and a positive attitude. This repository also provides one such platforms where contributers come over and put their ideas and make our website as interactive as much they can!
| Event Logo | Event Name | Event Description |
|---|---|---|
 |
GirlScript Summer of Code 2024 | GirlScript Summer of Code is a three-month-long Open Source Program conducted every summer by GirlScript Foundation. It is an initiative to bring more beginners to Open-Source Software Development. |
Style Share is a collaborative platform designed to streamline the process of creating and sharing Tailwind CSS components. Users can explore a wide range of design components created by the community, contribute their own, and engage with fellow designers and developers to enhance their web development projects.
- TypeScript
- Express
- React
- Recoil
- Prisma + MongoDB
- Tailwind
preview.mp4
Please note that this project is released with a Code of Conduct. By participating in this project you agree to abide by its terms.
- Go to the backend folder and create a .env file similar to .env.example
I. DATABASE_URL="mongodb+srv://<username>:<password>@<cluster-name>/syleshare" (replace <username>, <password>, and <cluster-name> with your actual MongoDB credentials)
II. JWT_SECRET="secret"
III. PORT=3001
IV. EMAIL_USER=example@gmail.com (replace with your actual email address)
V. EMAIL_PASS=lmkgpafolrjudvpc (16-digit password generated in Google, change this with yours)
VI. SEND_EMAIL=true (If you set it true ,you can able to send email otherwise it wont send)
VII. API_KEY="your google gemini api key" (replace with your actual Google Gemini API key)
I.EMAIL_PASS Generation video link
II.Remove spaces and add the password
-
Run the following commands in the backend folder
npm install npm run build npm run dev
The npm run build cmd will handle the Prisma migrations, and also build the frontend folder which will be served by the express server.
Possible Problems:
- Prisma may give error for MongoDB replica set, in such case use Mongodb atlas for the database instead of the local database or start a Mongo docker container with the replica set.
-
In case you are modifying the frontend and you want hot module reloading, then run the following commands in the frontend directory
npm install npm run dev
Also, set the default base URL of the backend (don't push this to GitHub) or simply uncomment the following: App.tsx lines 17-18
We welcome contributions from the community! To contribute:
- Fork the repository.
- Clone the repository.
git clone https://github.com/VaibhavArora314/StyleShare.git
- Create a new branch.
git checkout -b your-branch-name
- Make your changes.
- Commit your changes.
git commit -m 'Add some feature' - Push to the branch.
git push origin your-branch-name
- Open a pull request.
If you would like to contribute to the project then kindly go through Contributing Guidelines to understand everything from setup to necessary instructions.
This project is licensed under the MIT License. See the LICENSE file for more details.
for this project!