Welcome to ReadWonders, a robust community platform designed for creators to compose and share their narratives, articulate their emotions, and engage with a supportive audience. Whether you are an experienced writer or a novice, ReadWonders offers a versatile environment to unleash your creativity and refine your voice.
Warning This is a work-in-progress and not the finished product.
ReadWonders is in its very early days of development. We are working hard to provide an initial version as soon as possible and are accepting contributions.
Feel free to leave feature suggestions but please don't open issues for bugs or support requests just yet.
Follow me on GitHub @ujen5173 for updates.
- Next.js
- Tailwind CSS
- Prisma
- Supabase
- TRPC
- Posthog
- Uploadthing
- Offline Support
- Collaborative Writing
- Discussion Threads
- Achievements
- Live Writing Sessions
- Write Stories with AI Writing Assistant
- Like, Comment on Stories, Follow Creators, Notifications
- Personalized Feed
- Premium Subscription for Exclusive Content
- Schedule Stories
Make sure you have the following installed on your system:
- Node.js
- pnpm
- Supabase
- Clone the repository:
git clone https://github.com/your-username/ReadWonders.git- Navigate to the project directory:
cd ReadWonders- Install dependencies:
pnpm install- Set up environment variables:
Create a .env file in the root directory and add the environment variables referenced in the .env.example file.
- Create an account on Supabase.
- Populate the API keys in the
.envfile as referenced in.env.example. - Push the Prisma schema to Supabase:
pnpm db:push- Enable the RLS policy in all tables for security.
- Set up Supabase auth:
- Navigate to the SQL editor to set up the authentication process.
- Run the following SQL queries in the Supabase SQL editor one by one:
CREATE OR REPLACE FUNCTION public.handle_new_user()
RETURNS TRIGGER AS $$
DECLARE
username_suffix TEXT;
BEGIN
-- Generate a random number between 0 and 9999
SELECT to_char(floor(random() * 10000)::int, 'FM0000') INTO username_suffix;
-- Inserting into the profiles table
INSERT INTO public.profiles (id, name, email, profile, username)
VALUES (NEW.id,
NEW.raw_user_meta_data ->> 'full_name',
NEW.email,
NEW.raw_user_meta_data ->> 'picture',
lower(regexp_replace(NEW.raw_user_meta_data ->> 'full_name', '\s+', '', 'g')) || username_suffix);
RETURN NEW;
END;
$$ LANGUAGE plpgsql SECURITY DEFINER;
CREATE OR REPLACE TRIGGER on_auth_user_created
AFTER INSERT ON auth.users
FOR EACH ROW EXECUTE FUNCTION public.handle_new_user();
CREATE OR REPLACE FUNCTION public.handle_user_delete()
RETURNS TRIGGER AS $$
BEGIN
DELETE FROM auth.users WHERE id = old.id;
RETURN old;
END;
$$ LANGUAGE plpgsql SECURITY DEFINER;
CREATE OR REPLACE TRIGGER on_profile_user_deleted
AFTER DELETE ON public.profiles -- replace `profiles` with your profile table name
FOR EACH ROW EXECUTE FUNCTION public.handle_user_delete();- Adding Google signup:
Navigate to /auth/providers in Supabase, enable Google, and paste the API keys.
Start the development server:
pnpm devThe application will be available at http://localhost:3000.
We welcome contributions from the community. Please follow these steps to contribute:
-
Fork the repository.
-
Create a new branch:
git checkout -b feature-branch- Commit your changes:
git commit -m 'Add some feature'- Push to the branch:
git push origin feature-branch- Open a pull request.
Please make sure your code adheres to our coding standards.
Thank you for contributing to ReadWonders! Together, we can build a platform where every story matters and every voice is heard.