https://github.com/r3nanp/happy-server
A web server for Happy, to make orphanages closer to you!
https://github.com/r3nanp/happy-server
express happy images multer mvc nodejs orphanages postgresql server typescript
Last synced: 3 months ago
JSON representation
A web server for Happy, to make orphanages closer to you!
- Host: GitHub
- URL: https://github.com/r3nanp/happy-server
- Owner: r3nanp
- License: mit
- Created: 2021-08-05T15:25:06.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-08-18T16:10:38.000Z (almost 5 years ago)
- Last Synced: 2025-03-02T01:47:35.944Z (over 1 year ago)
- Topics: express, happy, images, multer, mvc, nodejs, orphanages, postgresql, server, typescript
- Language: TypeScript
- Homepage:
- Size: 168 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# happy-server
An web server for Happy, to make orphanages closer to you!
# Technologies used 🛠
- Node.js
- Express
- TypeORM
- Multer
- Cors
- Yup
- PostgreSQL
# Contributing 🎉
[Check this step by step](CONTRIBUTING.md)
# 👷♂️ Installation
**You need to install [Node.js](https://nodejs.org/en/download/) and [Yarn](https://yarnpkg.com/) first, then in order to clone the project via HTTPS, run this command:**
```
git clone https://github.com/r3nanp/happy-server.git
```
SSH URLs provide access to a Git repository via SSH, a secure protocol. If you use a SSH key registered in your Github account, clone the project using this command:
```
git clone git@github.com:r3nanp/sellapi.git
```
**Install dependencies**
```
yarn install
```
Or
```
npm install
```
Create your enviroment variables based on the examples of ```.env.example```
```
cp .env.example .env
```
After copying the examples, make sure to fill the variables with new values.
**Setup a database**
Install [Postgres](https://www.postgresql.org/) to create a database or if you have [Docker](https://www.docker.com/) in your machine, fill the environment values related to database configurations and then run the following commands in order to create a Postgres container.
```docker-compose up -d```
# 🏃 Getting Started
Run the transactions in order to configure the database schema
```yarn typeorm migration:run```
Run the following command in order to start the application in a development environment:
```yarn dev```
# :closed_book: License
Released in 2021.
This project is under the [MIT license](LICENSE).
Made with love by [Renan Pereira](https://github.com/r3nanp) 💜🚀