https://github.com/writeonlycode/next-overflow
Next Overflow is an open-source starter project built with Next.js and Supabase that provides a solid foundation for building a StackOverflow-like web application.
https://github.com/writeonlycode/next-overflow
Last synced: 6 months ago
JSON representation
Next Overflow is an open-source starter project built with Next.js and Supabase that provides a solid foundation for building a StackOverflow-like web application.
- Host: GitHub
- URL: https://github.com/writeonlycode/next-overflow
- Owner: writeonlycode
- License: mit
- Created: 2023-05-15T01:21:16.000Z (over 2 years ago)
- Default Branch: alpha
- Last Pushed: 2023-07-02T03:08:32.000Z (over 2 years ago)
- Last Synced: 2024-12-29T08:11:43.324Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://next-overflow.vercel.app
- Size: 164 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Next Overflow
Next Overflow is an open-source starter project built with Next.js and Supabase
that provides a solid foundation for building a StackOverflow-like web
application. It's designed to enable developers to quickly set up a
feature-rich platform for users to ask and answer questions on various topics,
search for existing questions, and vote on answers. Next Overflow is ideal for
developers looking to create a similar platform or seeking inspiration for
their project. Potential users include developers who want to learn and
practice building full-stack applications, startups, and businesses looking to
create a Q&A platform for their customers or employees.
((Main Screenshot))
## Demo Website
To see a live demo of Next Overflow, please visit (...). Please note that this
is a demo website and not a official website. If you have any questions or
feedback, please feel free to contact us!
## Features
Next Overflow currently includes the following features:
- **Ask Questions:** Users can submit questions through a form that saves them
to the Supabase database.
- **Answer Questions:** Users can answer questions submitted by other users
through a form that saves their answers to the Supabase database.
- **Search for Questions:** Users can search for questions using a search bar
that queries the Supabase database for matching questions and displays them
to the user.
- **Upvote/Downvote Questions & Answers:** Users can upvote or downvote
questions & answers to questions, with the total vote count displayed next to
each questions & answer.
## Future Improvements
Next Overflow is a work in progress, and future improvements may include:
- **Question Categories:** Users will be able to categorize their questions by
topic, making it easier for other users to find relevant questions and
answers.
- **Comment on Questions/Answers:** Users will be able to leave comments on
questions and answers, allowing for more in-depth discussions.
## Technologies Used
Next Overflow is built using the following technologies:
- **Next.js:** A popular open-source React framework for building server-side
rendered (SSR) web applications.
- **SWR:** A React Hooks library that provides a data-fetching solution with
client-side caching and automatic revalidation. It enables efficient handling
of requests for data that is frequently updated and provides a smooth user
experience by returning cached data while fetching updated data in the
background.
- **Supabase:** An open-source backend as a service (BaaS) platform that
provides developers with tools to build scalable and secure web and mobile
applications faster.
- **Tailwind CSS:** A popular utility-first CSS framework that makes it easy to
create responsive and customizable user interfaces.
## Running Locally
To get started with Next Overflow, follow these steps:
1. Clone the repository to your local machine.
2. Install dependencies by running npm install.
3. Create a .env.local file and add your Supabase API key and URL. You can find
these in your Supabase project settings.
4. Start the development server by running npm run dev.
## Deploying to Vercel
Next Overflow can be easily deployed to Vercel by following these steps:
1. Create a new project on Vercel and connect it to your GitHub repository.
2. In the "Build & Development Settings" section of your Vercel project
dashboard, add the following environment variables:
```bash
NEXT_PUBLIC_SUPABASE_URL=
NEXT_PUBLIC_SUPABASE_ANON_KEY=
```
3. Deploy the app by pushing your changes to your GitHub repository. Vercel
will automatically build and deploy your app.
4. Once the deployment is complete, you can access the app by clicking the
"Visit" button in your Vercel project dashboard.
## Screenshots
(...)