HushHushDiaries

Index

• 1. Introduction
• 2. Documentations
  • 2.1. Idea Description
  • 2.2. Problem Description
  • 2.3. Requirements Documentation
  • 2.4. Product Documentation
  • 2.5. Process Documentation
• 3. Development
  • 3.1. Requirements
  • 3.2. Setup
  • 3.3. Run
  • 3.4. Packages used

1. Introduction

The online forum, Hush Hush Diaries, is a place where it is possible for people with interests and social challenges to interact anonymously and safely.

2. Documentations

2.1. Idea Description

In progress of being developed.

2.2. Problem Description

In progress of being developed.

2.3. Requirements Documentation

In progress of being developed.

2.4. Product Documentation

In progress of being developed.

2.5. Process Documentation

In progress of being developed.

3. Development

3.1. Requirements

These things are required to run the development environment.

• node.js v16.0.0
• netlify-cli v11.5.1

3.2. Setup

1. Clone project from Github.
2. npm install -g npm to update to latest version of npm.
3. npm install -g netlify-cli to install the local runtime environment.
4. npm install to install dependencies.
5. netlify env:import .env to fetch environment configurations.

3.2.1 How to link to Netlify.

1. netlify link to form a link (id from netlify site configuration)

3.3. Run

1. netlify dev --filter hushhushdiaries-api to run the local runtime environment.

3.4. Packages used

Packages:

These packages are used in the main project.

• cross-env v7.0.3
• npm-run-all v4.1.5

API packages:

These packages are used in the api project.

• typescript v5.1.6
• aws-lambda v1.0.7
• dotenv v16.3.1
• hashids v2.3.0
• kysely v0.36.1
• kysely-planetscale v1.4.0
• lambda-api v1.0.3

Website packages:

These packages are used in the website project.

• angular v16.2.0
• jwt-decode v3.1.2