Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/burhan-syed/WebRoll
A place to submit and discover creations on the internet.
https://github.com/burhan-syed/WebRoll
astrojs daisyui discovery prisma reactjs tailwindcss websites
Last synced: about 2 months ago
JSON representation
A place to submit and discover creations on the internet.
- Host: GitHub
- URL: https://github.com/burhan-syed/WebRoll
- Owner: burhan-syed
- Created: 2022-09-03T21:37:41.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-07T21:31:47.000Z (almost 2 years ago)
- Last Synced: 2024-07-10T12:05:00.663Z (3 months ago)
- Topics: astrojs, daisyui, discovery, prisma, reactjs, tailwindcss, websites
- Language: TypeScript
- Homepage: https://webroll.io
- Size: 760 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
WebRoll
A place to gather and discover commendable creations on the internet.
## Description
### The Website
WebRoll.io allows users to submit websites for others to discover. When submitting, you are asked to select from a predefined list of categories and freely enter tags to properly catalogue the site. WebRoll then parses the site and submits it into a queue for moderators of WebRoll to review. If the submission is approved the site will be available for discovery.
Users of WebRoll.io discover sites simply by pressing the "Next" button on the explore page. A site is randomly shown from the database of approved sites. Users have the ability to narrow the scope of websites shown by selecting from the preset categories. Users are also able to save sites by leaving a like and leave suggestions to correct miss-labeled categories, tags, or broken websites with a report button.
Every submitted site also creates a unique page in the /sites directory with information such as how many times the site was viewed as users were "rolling" on the explore page and the number of likes it has received. This page is also shareable.
### Primary Technologies
This site was built with Astro and React with Typescript. It was styled with DaisyUI and TailwindCSS.
The MySQL database is queried and managed with Prisma. Rate-limiting is handled with an Upstash Redis cache.
Playwright is used to screenshot sites for backup images in case embedding is not possible. This is maintained on a separate Fastify server ([repo here](https://github.com/burhan-syed/webroll-parser)) due to size limitations with Vercel's serverless AWS Lambda functions. All screenshots are stored in a S3 bucket.
## Getting Started
### Installing
Clone this repo. If you want to screenshot sites follow directions to ([setup this repo as well](https://github.com/burhan-syed/webroll-parser)).
### Executing program
- Follow the .example.env file to create a .env with all necessary environment variables. Only the DATABASE_URL is strictly necessary but others are needed for AWS, authentication, and email service. If no Upstash variables are provided you will need to clear the rate-limit check.
- To install and run:
```
yarn
yarn dev
```
or
```
npm install
npm run dev
```
## Version History
- 0.2
- History Page
- 0.1
- Initial Release
## Roadmap
- [x] History page to easily find previous rolls.
- [ ] Search by tags
- [ ] General search
- [ ] Aggregate sites performance page (likes, views)
- [ ] User created custom collections
## Acknowledgments
This project was heavily inspired by [CloudHiker](https://cloudhiker.net)
Libraries:
- [Astro](https://github.com/withastro/astro)
- [React](https://github.com/facebook/react)
- [TailwindCSS](https://github.com/tailwindlabs/tailwindcss)
- [DaisyUI](https://github.com/saadeghi/daisyui)
- [React-Hook-Form](https://github.com/react-hook-form/react-hook-form)
- [Tanstack/Query](https://github.com/TanStack/query)
- [Tanstack/Virtual](https://github.com/TanStack/virtual)
- [Prisma](https://github.com/prisma/prisma)
- [Upstash/Ratelimit](https://github.com/upstash/ratelimit)
- [Nodemailer](https://github.com/upstash/ratelimit)
- [Astro-Auth](https://github.com/astro-community/astro-auth)