An open API service indexing awesome lists of open source software.

https://github.com/jordanopensource/dsp-web

Web client for Aman Raqami
https://github.com/jordanopensource/dsp-web

digital-safety hacktoberfest nuxt nuxtjs privacy privacy-tools tailwindcss

Last synced: 6 months ago
JSON representation

Web client for Aman Raqami

Awesome Lists containing this project

README

          





Logo

dsp-web


The web client for the JOSA Digital Safety Portal.


Explore the docs »




Visit the Portal
·
Report Bug
·
Request Feature

[![Build Status](https://builds.josa.dev/api/badges/jordanopensource/dsp-web/status.svg)](https://builds.josa.dev/jordanopensource/dsp-web)

Table of Contents




  1. About The Project



  2. Getting Started


  3. Usage

  4. Roadmap

  5. Contributing

  6. License

  7. Contact

  8. Acknowledgements

## About The Project

This is a Nuxtjs web client for the [JOSA Digital Safety Portal](https://amanraqami.org).

### Built With

* [Nuxt.js](https://nuxtjs.org)
* [Tailwind CSS](https://tailwindcss.com/)

## Getting Started

To get a local copy up and running follow these simple steps.

### Prerequisites

1. Download and install the latest version of Node.js from [here](https://nodejs.org/en/download/).

### Installation

1. Clone the repo
```sh
git clone https://github.com/jordanopensource/dsp-web.git
```
2. Install NPM packages
```sh
npm install
```

### Running

#### Development

To run the project locally for development purposes:

1. Run the project

```sh
$ npm run dev
```

2. Go to `http://localhost:3000`

#### Production

To build and run the project locally for production purposes:

1. Build the project

```sh
$ npm run build
```

2. Launch the production server

```sh
$ npm run start
```

## Roadmap

See the [open issues](https://github.com/jordanopensource/dsp-web/issues) for a list of proposed features (and known issues).

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

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

## License

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

## Contact

Jordan Open Source Association - [@jo_osa](https://twitter.com/@jo_osa) - info@josa.ngo

Project Link: [https://github.com/jordanopensource/dsp-web](https://github.com/jordanopensource/dsp-web)