https://github.com/dadangdut33/personal-web-backend

Server code of my personal web
https://github.com/dadangdut33/personal-web-backend

cors express nodejs swagger typescript

Last synced: 3 months ago
JSON representation

Server code of my personal web

• Host: GitHub
• URL: https://github.com/dadangdut33/personal-web-backend
• Owner: Dadangdut33
• License: mit
• Created: 2022-09-03T11:50:53.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-02-29T10:21:42.000Z (10 months ago)
• Last Synced: 2024-03-01T12:13:07.087Z (10 months ago)
• Topics: cors, express, nodejs, swagger, typescript
• Language: TypeScript
• Homepage: https://witty-fox-train.cyclic.app/
• Size: 741 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  

  


  

  



Backend code of my personal web. Made using express. Take a look at [frontend](https://github.com/Dadangdut33/Personal-Web) for frontend code.

# Table of Contents

- [Table of Contents](#table-of-contents)

- [Getting started](#getting-started)

  - [Set up your .env](#set-up-your-env)

  - [Available Scripts](#available-scripts)

    - [`pnpm start`](#pnpm-start)

    - [`pnpm run dev:ts`](#pnpm-run-devts)

    - [`pnpm run watch`](#pnpm-run-watch)

    - [`pnpm run build`](#pnpm-run-build)

  - [Run in ease while developing](#run-in-ease-while-developing)

# Getting started

Before contributing please consider reading some of the [docs](docs):

- [CONTRIBUTING.md](docs/CONTRIBUTING.md)

- [resources.md](docs/resources.md)

To start developing, first make sure that you have node installed. After that do `pnpm install` to install all the dependencies.

## Set up your .env

Don't forget to set up your .env file located in root folder. You can follow the template in the [.env.example](.env.example) file.

## Available Scripts

In the api directory, you can run:

### `pnpm start`

Runs the API in the production mode (Compiled).

### `pnpm run dev:ts`

Runs the API in the development mode (Not compiled).

### `pnpm run watch`

Watches and re-compiles on every changes made to the codebase.

### `pnpm run build`

Builds the API for production to the `dist` folder.

## Run in ease while developing

1. Method 1: Compile and watch for changes in the codebase

   - open a new terminal and run `pnpm run watch`

   - then open another terminal and run `pnpm run dev`

2. Method 2: Use nodemon

   - run `pnpm run dev:ts`

**_this will get faster as it automatically re-compiles on the background_**