danang-id / asmr

A simple Coffee Beans management solution.

asmr

A simple Coffee Beans management solution.
Try Web Dashboard

Table of Contents

1. About asmr
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact

About asmr

asmr is your solution for coffee beans management. You can manage your bean inventory, track down green bean to roasted bean production, and manage roasted bean transaction. You can also see the production report to see how well your bean is being roasted.

To be able to access asmr on your workplace, you need to contact your workplace Administrator and provide the information about your employment information. The Administrator then will be able to register and grant you access to the system.

(back to top)

Built With

Powered by NET 6.0 and React.

(back to top)

Getting Started

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

Prerequisites

Please make sure have you following installed.

• NET SDK 6.0 or newer
• NodeJS 16 or newer
• Yarn Package Manager

Installation

1. Clone this repo

   git clone https://github.com/danang-id/asmr.git
   cd asmr

2. Install NPM packages

   cd ASMR/Web
   yarn install

3. Generate a X509 certificate with PCKS#8 RSA private key. You may want to use [CertificateTools.com] (https://certificatetools.com) to generate this certificate. Download the certificate and save it to ASMR.Web/Keys/DataProtectionCertificate.pfx. If you set up a password for the certificate, you should configure the password on the appsettings.Local.json as described below.
4. Generate a long random string for JSON Web Token (JWT) key, and configure that to the appsettings.Local.json as described below.
5. Prepare Google reCAPTCHA Secret Key. You can obtain it on the Google reCAPTCHA Admin Panel.
6. Prepare SendGrid API Key, Contact List Id, and Mail Templates Id. You can obtain them on the SendGrid Dashboard.
7. Save those secrets by creating appsettings.Local.json file (if not exists) in the ASMR.Web folder. Use the following template for appsettings.Local.json.

   {
      "DataProtection": {
         "Certificate": {
            "Password": ""
         }
      },
      "JsonWebToken": {
         "Key": ""
      },
      "Google": {
         "reCAPTCHA": {
            "SecretKey": ""
         }
      },
      "SendGrid": {
         "ApiKey": "",
         "ContactListId": "",
         "Templates": {
            "EmailAddressConfirmation": "",
            "EmailAddressChanged": "",
            "RegistrationPendingApproval": "",
            "RegistrationRejected": "",
            "Welcome": "",
            "PasswordReset": ""
         }
      }
   }

(back to top)

Run and Build

To run this application for development, follow these steps.

1. Open Terminal / Command Prompt at ASMR.Web/ClientApp folder, and type:

   yarn start

2. Open Terminal / Command Prompt at ASMR.Web folder, and type:

   dotnet run

To build this application for release, follow these steps.

1. Open Terminal / Command Prompt at ASMR.Web/ClientApp folder, and type:

   yarn build

2. Open Terminal / Command Prompt at ASMR.Web folder, and type:

   make release

Make sure you have make installed. If you are on Windows, follow the answer of this question on the StackOverflow. The binary output should be in the ASMR.Web/Releases folder.

(back to top)

License

This project is licensed under the BSD 3-Clause License. See LICENSE.md for more information.

(back to top)

Contact

Danang Galuh Tegar Prasetyo - @dananggaluht - [email protected]

Project Link: https://github.com/danang-id/asmr

(back to top)