afictionado / afictionado

A cozy home for fiction 🧑✍

Afictionado - A cozy home for fiction 🧑✍

Table of Contents

1. About The Project
   • Vision
   • Goals
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project 🖼️

Afictionado (portmanteau between "fiction" and "aficionado") is an archive for fictional content - original works, fanworks (including fanfiction, edits, fanart, etc.) and anything in between!

Vision 🌠

Coming from a time where what we had was Wattpad, AO3, I wanted to create a second Archive of Our Own, but with a more accessible UI and unified API. What was initially a passion project idea, will, I hope, grow much larger into something people wil enjoy using.

(No knock on AO3 or the other fanfiction platforms, by the way. We all stand on the shoulders of giants, and I'm infinitely grateful for having AO3 and such.)

(back to top)

Built With 🛠️

This project wouldn't be possible without these technologies, all of which I'm thankful for having the chance to use. You can expect most if not all of these projects to be open-sourced and free for others to use (non-commercially).

(back to top)

Getting Started 🏃

Prerequisites 📥

• npm

  npm install npm@latest -g

• Supabase
  • There are two places which you will need to replace this project's (public) keys with:
    • ./package.json, where the update-types command uses your Supabase project's ID.
    • static/.env, where you need to put your anon key and your Supabase project's URL in. (Please ensure that your data is protected with RLS before you proceed to expose the keys to the public!)

Installation 📲

1. Clone the repo

   git clone https://github.com/afictionado/afictionado.git

2. Install NPM packages

   npm install

3. Build and serve!

npm run build
node build

(back to top)

Roadmap 📍

Expect to see something here soon!

(back to top)

Contributing 🙌

Contributions are what make the open source community such an amazing place to learn, inspire, and create. 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. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your feature Branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing-feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a pull request

(back to top)

License 🪪

This project is distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact me!

Viet - [email protected]

Project Link: https://github.com/afictionado/afictionado

(back to top)

Acknowledgments

Apart from the major technologies listed above, this project wouldn't have been possible without the support of:

• AO3, Wattpad, Fanfiction.net, Quotev, Tumblr, etc. There are too many to list.
• This README was built based on this amazing template.

(back to top)