Coder Social home page Coder Social logo

bloggly's Introduction

Contributors Forks Stargazers Issues MIT License


Logo

Bloggly

A simple blogging platform
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Acknowledgments

About The Project

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.

(back to top)

Built With

(back to top)

Getting Started

To test out this software we need to install the dependencies, start docker, and then run the ui & api servers.

Prerequisites

Install yarn

  • npm
    npm install npm@latest -g
    or check yarn installation for alternative methods
  • docker Go here for details on installing docker for your operating system

Installation

To install the bloggly run the following commands.

  1. Clone the repo
    git clone https://github.com/Th3Whit3Wolf/bloggly.git
  2. Move into the newly created repo directory
    cd bloggly
  3. Install project dependencies
    yarn

Usage

To run we need to start docker to get the database running and the start our frontend and backend servers

  1. Run docker
    docker compose up -d
  2. Startup the servers
    yarn workspace api run dev & && \
    yarn workspace ui run dev

(back to top)

Roadmap

  • Feature 1
  • Feature 2
  • Feature 3
    • Nested Feature

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

(back to top)

Contributing

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!

  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

(back to top)

License

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

(back to top)

Acknowledgments

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!

(back to top)

bloggly's People

Contributors

th3whit3wolf avatar

Watchers

 avatar  avatar

bloggly's Issues

As a visitor I want to be able to view all posts created by all users so that I can consume content

As a visitor I want to be able to view all posts created by all users so that I can consume content.

As a/an I want to ... So that ...
visitor be able to view all posts created by all users I can consume content

Acceptance Criteria

Notes

  • Unauthenticated users should be able to view all posts, and any single post.
  • The posts should only display the first 100 characters with “...” at the end if they are longer than 100 characters.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.