Zackius / mastori-frontend

A frontend development for the SpaceYaTech Mastori blog application. This is a community-driven open-source project that aims to let users to quickly publish content and share it with ease to their audience.

Space Ya Tech Blog Frontend

About

This repository contains the frontend code for the Space Ya Tech blog application. The blog frontend is built using React and Vite, and communicates with the backend API to display and manage blog content.

Set up the project

Prerequisites

To run the project on to your system, need to have the following installed .

• Node and NPM packages, all latest versions.
• Install appropriate code editor or Interactive Development Environment (IDE)

Setup and running the project locally

1. Fork the repo project to your personal account

2. Clone the repo to your local machine/environment

    https://github.com/user-name/blog-frontend.git "Using HTTPS"
   
   or
   
    [e-mail]:user-name/blog-frontend.git      "Using ssh"

3. cd blog-frontend and install dependencies

   npm install

4. Start development server

   npm run dev

5. The blog frontend will now be available at http://localhost:3000.

Design

• All development will be in reference to our Figma file link

Run app with Docker

To install Docker:

Docker for windows

install docker on windows

Docker for linux (Ubuntu)

docker on ubuntu

To run the app using docker:-

Docker in Development

Run:

npm run docker:dev

Then go to http://localhost:3000

Alternatively:

• Run the project locally using docker-compose docker-compose up
• The application should be running on http://localhost:3000

Docker in production '** still working on this'

Run:

npm run docker:prod

• Then go to localhost:3000 or the production domain

Contributing

Contributing

To contribute to the blog frontend, follow these steps:

1. Find an open issue on the issues page that you would like to work on.
2. Assign the issue to yourself and create a new branch

   git checkout -b branch-name

3. Work on the issue by making changes to the codebase.
4. Add git add . and commit git commit -m "short and descriptives messages" your changes
5. Once you have finished working on the issue, push your changes to GitHub:

   git push

6. Open a Pull Request on GitHub for your changes to be reviewed and merged into the main branch.
7. Make sure to comment on your pull request with any relevant information about your changes.

Adding Comments to Your Work

To add comments to your work on an issue, follow these steps:

1. When working on an issue, make sure to add relevant comments to your code to explain what you are doing.

2. After committing your changes, include a comment in the commit message to explain what changes you made and why.

3. When creating a pull request, make sure to include a summary of your changes and any relevant comments in the description.

4. If your changes address a specific issue, make sure to reference the issue in your pull request description.

5. Once your changes have been reviewed and merged, make sure to close the relevant issue and add a comment to explain how your changes resolved the issue.

Communication

For any communication and challenges regarding the project Discussion board is always open

Conclusion

By following these guidelines, you can contribute to the Space Ya Tech blog frontend and help improve the overall user experience of the blog application. Remember to communicate frequently with the other developers in the community and to ask for help or feedback whenever you need it. Together, we can create an amazing blog frontend for the Space Ya Tech community. Team

• https://github.com/orgs/SpaceyaTech/people