dbstratta / margaret

👩‍🚀 A publishing platform. An open-source alternative to Medium.

This is the umbrella repository of Margaret.

Table of contents

• Introduction
• Features
• Contributing
• Project structure
• Projects
• License

Introduction

Margaret is an open-source publishing platform (think of Medium). The initial scope is to implement the majority of features Medium has. In the future, we'll implement features that will set Margaret apart.

Features

• Authentication

  • Users can sign up and sign in using their Facebook, Google and/or GitHub accounts

  • Users can sign in by clicking a magic link sent to their emails

• Stories

  • Basic functionality

  • Views are counted

  • Users can publish monetized stories that only members can read

• Memberships

  • Users can opt in to our membership program

  • Members have access to a wider selection of stories

• Notifications

  • Basic functionality

  • Users can see only their notifications

  • Users can mark a notification as read

  • Some notifications send emails

  • Real-time functionality

• Publications

  • Basic functionality

  • Admins can invite users to the publication

  • Members of the publication can have different roles (writer, editor, etc)

  • Writers can create drafts under the publication

  • Editors can edit and publish drafts under the publication

• Recommendation system

  • The users' feeds are personalized based on their interests thanks to machine learning

• Follow system

  • Basic functionality

  • Users can follow other users and publications

• Star system

  • Users can star stories and comments

• Bookmark system

  • Users can bookmark stories and comments to read later

Contributing

Please see CONTRIBUTING.

Project structure

• __tests__: Contains end-to-end tests written in JavaScript with Jest.

• .github: Contains GitHub template files.

• .vscode: Contains VSCode workspace configuration files.

• k8s: Contains Kubernetes manifests for production deployment.

• projects: Contains the projects Margaret consist of.

• scripts: Contains useful scripts for CI and other things.

Projects

• api: Margaret's main API (Elixir, Phoenix & Absinthe).
• ml: Machine learning predictions service (Django).
• web: Web app (React).
• mobile: Mobile app (React Native).

Scripts

• build.sh: Builds and tags the Docker images.

• deploy.sh: Builds, tags and pushes the Docker images.

• gen_env_file.sh: Copies the example env file to the actual env file.

• push.sh: Pushes the Docker images.

• test.sh: Runs all the tests.

License

MIT

margaret's Issues

Logo design for margaret

Hello! I am a graphic designer. I want to contribute to margaret. Do you want me to design a logo for the margaret? Actually, i have an idea. If you have an idea, you can say me.

As an API consumer, I want to have descriptive error messages so that I can undestand better what happened wrong

Machine learning

Make status page

Possibly written in Go to try it out.

Publications

As a user, I want to comment on stories so that I can express myself regarding the story

As a user, I want to create and edit stories from a WYSISYG editor integrated in the UI

Bootstrap web project

As an user, I want to schedule the publication of a story to a future time so that it publishes my story automatically at the time specified

Improve the the way the project is documented

Hello here,

I would like to contribute to this project. So, I tried to follow the current documentation (various .md files in the project) but I was unable to run the application (e.g. if a database is required, or other setup information) or to run all the tests (what I see is that there are no tests at all, in the api project for example.)

Without tests it can be very difficult to change the code, maintain it or add a new feature.

So, in order to contribute I think it could be useful to put these information somewhere (maybe the main README.md can be the right place?).

I see that the project can use Docker. The way to use docker-compose or to use Docker in order to run the application can be documented, too. For example if a were a developer that wants to run the application locally, it could be very useful.

What do you think?

Other nice-to-have improvements for the project

• Maybe a Gitter chat room can be useful to talk about the project
• Maybe a TravisCI can be useful to setup a Continuous Integration process.

Automate Elixir dependency updates

Hey, I noticed you were using Renovate for automated JavaScript updates, and wondered if you'd be up for giving Dependabot a go for automated Elixir dependency updates. I built it, and it's totally free for open source projects (and always will be) - I'm just trying to get more people using it.

As a user, I want to have a notification system so that I can read notifications related to me

Comment system

Notification system

As a user, I want to follow other users so that I can get notifications when the followed user publishes new content

As a user, I want to be able to deactivate my account so that I can temporarily get out of the platform

Project MVP

Bootstrap api project

Collections

As a publication admin, I want to send invitations to users to join my publication, so that the publication can grow

Follower system

As a developer I want to have a basic project structure so I can start developing the application

As a user, I want to be able to star stories so that I can show my appreciation for the story

Create background job that deletes accounts marked for deletion after the specified time has passed

Related to #212.

Consider gRPC and Protobuf for inter-service communication

Comment system

As a user, I want to be able to delete my account so that I can permanently get out of the platform

Recommendation system

This would be a good use case for a model for each user to learn about their patterns of viewing, commenting and other things to recommend more accurate stories.

Migration to Kubernetes

As a user, I want to create publications so that their writers can publish stories for it

Investigate After.js, Reason and ReasonReact

How to run

How to run the application.

Real-time functionality

Story creation

Add tests