magazine-maker

An app that allows anyone to share their magazines in an easy, free, self-hosted way!

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

This project started when I had to update an website for an online magazine and realized how hard it was to maintain it, since it was built with bad wordpress.

It's purpose is to allow anyone who wishes to host an online magazine on their own domain, to do this for free and without headache.

Built With

• React
• Ant Design
• Firebase

Getting Started

Prerequisites

• yarn

  npm install --global yarn

Installation

1. Clone the repo

   git clone https://github.com/stoicaandrei/magazine-maker.git

2. Install NPM packages

   yarn install

3. Create a new project at https://console.firebase.google.com
4. Go to the Cloud Firestore section, and under Data, create a new collection called magazines
5. Then create a new Document with a string field called title
6. Not go to the Rules Tab and replace the permissions

   allow read: if true;
   allow create, update, delete: if false;
   

7. Go to the Hosting section and follow the instructions
8. Enter your own firebaseConfig in src/firebase_config/index.ts

   const firebaseConfig = {
     apiKey: "",
     authDomain: "",
     projectId: "",
     storageBucket: "",
     messagingSenderId: "",
     appId: "",
     measurementId: ""
   };

Usage

To start the project use yarn start

You should be able to see the created document in the list, go ahead and edit it.

The format is:

type Magazine = {
  title: string;
  thumbnailUrl: string;
  pageUrls: string[];
  backgroundUrl: string;
};

Roadmap

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

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

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

License

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

Contact

Andrei Stoica - @your_twitter - andrei00stoica@gmail.com

Project Link: https://github.com/stoicaandrei/magazine-maker