BulletinBoard

The front end of the BulletinBoard application. A functional announcement app that you can create/delete/edit announcements to specific category.

Teck Stack

The project is build with React. It uses Tailwind CSS for styling and JSON Server for the backend.

For continuous integration and continuous deployment it uses Netlify CI/CD and for the deployment Netlify.

Run it locally

1. Clone the project on your local machine.
   $ git clone https://github.com/basilisSam/BulletinBoard.git

2. Navigate to the project folder and install the dependencies with the following command.
   $ yarn install

3. Run the application locally (the application can be accessed from localhost:3000)
   $ yarn dev

Available scripts

Run app locally

You can run the application locally by using yarn dev. This command will spin up the webpack-dev-server and the JSON server by running both commands concurrently.

Run react app

You can start the react application by using yarn start (you will need the json-server running).

Run json-server

You can start the json-server by using yarn jserver.

Run json-server

You can start the json-server by using yarn jserver

Build

You can build the application in production mode with yarn build

Note: You can use npm instead of yarn

Documentation

BulletinBoard documentation is available here.

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build to BulletinBoard.