Table of Contents
There are many blogging platforms out there but this one is mine.
Please DON'T use this. This is a project for a course. It is not suitable for anyone.
To test out this software we need to install the dependencies, start docker, and then run the ui & api servers.
Install yarn
- npm
or check yarn installation for alternative methods
npm install npm@latest -g
- docker Go here for details on installing docker for your operating system
To install the bloggly run the following commands.
- Clone the repo
git clone https://github.com/Th3Whit3Wolf/bloggly.git
- Move into the newly created repo directory
cd bloggly - Install project dependencies
yarn
To run we need to start docker to get the database running and the start our frontend and backend servers
- Run docker
docker compose up -d
- Startup the servers
yarn workspace api run dev & && \ yarn workspace ui run dev
- Feature 1
- Feature 2
- Feature 3
- Nested Feature
See the open issues for a full list of proposed features (and known issues).
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!