Skip to content
This repository has been archived by the owner on Dec 16, 2022. It is now read-only.
/ flare Public archive

Social Blogging Platform inspired by sites like DEV.to and Zenn.

License

Notifications You must be signed in to change notification settings

mtergel/flare

Repository files navigation


Logo

Flare

Write for yourself

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

Flare

Flare is an information-sharing community for developers. Share your insights with someone. It is fully responsive and has dark mode support. You can write using markdown. It supports syntax highlighting, GitHub syntactic, and others. Preview articles and publish them for others to see. Or create a scribble to organize details in a thread format.

Motivation

Open-source hobby project made with ❤️. I've written this project from scratch to share what I have learned while building a project for my portfolio. Here is my lighthouse scores for home page which has ISR enabled. Lighthouse Scores

Built With

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Create a Supabase project. Enable authentication. The project uses only Google and Github OAuth providers.

Todo: Create a script to replicate schema, for now, you can copy the schema. Or you can use the generated types file for reference.

Installation

  • Clone the repo
git clone https://github.com/mtergel/flare
  • Install dependecies
yarn install
  • Create an .env.local file. Add these values.
NEXT_PUBLIC_SUPABASE_URL=
NEXT_PUBLIC_SUPABASE_ANON_KEY=
NEXT_PUBLIC_SALT=
SERVICE_KEY=
SUPABASE_JWT_SECRET=
  • Run the development server.
yarn dev

Open http://localhost:3001 with your browser to see the result.

Roadmap

  • Notification
  • Users follows/followers
  • Tag following

See the open issues for a full list of proposed features (and known issues).

Contributing

I have no experience building backends so any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

If use like using the site feel free to buy me a coffee.

Buy Me A Coffee

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Tergel Munkhdelger - Portfolio - tergelm@gmail.com

Project Link: https://github.com/mtergel/flare/

Acknowledgments

It is heavily inspired from Zenn.dev.

(back to top)

About

Social Blogging Platform inspired by sites like DEV.to and Zenn.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published