README.md

BranchPage

A platform for deploying blogs using .md files on GitHub.

✅ Features

• Totally free. 💸
• Blog can be created in seconds ⏩
• You content is always safe on github
• Readers can contribute to your posts 🔨
• Donation links available through your blog (Coming soon.) 💰

And much more features coming 😁

🚀 Installation and execution

1. Clone this repository and go to the directory;
2. Create a .env file with the following variables
   • GITHUB_API_TOKEN - Create a personal access token (no scope needed);
   • GITHUB_OAUTH_CLIENT_ID and GITHUB_OAUTH_CLIENT_SECRET - Create an OAuth application with homepage url http://127.0.0.1:4000 and callback http://127.0.0.1:4000/auth/github/callback.

📦️ Running for the first time

1. Run docker-compose build;
2. Install mix dependencies docker-compose run --rm web mix deps.get;
3. Create database docker-compose run --rm web mix ecto.create;
4. Run the migrations docker-compose run --rm web mix ecto.migrate;
5. Install npm dependencies docker-compose run --rm web npm install --prefix apps/web/assets;

🔧 Development

1. Run docker-compose up;
2. Access localhost:4000;

🧪 Tests

1. Run docker-compose run --rm web mix ci;

🤔 How to contribute

• Fork this repository;
• Create a branch with your feature: git checkout -b my-feature;
• Commit your changes: git commit -m 'My new feature';
• Push to your branch: git push origin my-feature.

After the merge of your pull request is done, you can delete your branch.

---