dbstratta / margaret Goto Github PK

View Code? Open in Web Editor NEW

92.0 92.0 13.0 3.7 MB

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

License: MIT License

JavaScript 11.80% Elixir 85.05% HTML 0.39% Shell 0.90% Python 0.94% TypeScript 0.12% Dockerfile 0.81%

absinthe apollo blogs docker ecto elixir graphql kubernetes machine-learning medium notifications phoenix react redux

margaret's People

Contributors

Stargazers

Watchers

Forkers

haibo32012 joebew42 gitter-badger parallel588 reallinfo shivamgupta211 alectorlab altovate batuhanaydn nduatik annrapid brunolca jesussqs

margaret's Issues

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

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

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

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

Consider gRPC and Protobuf for inter-service communication

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

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

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

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.