This REST API server application is built to serve its endpoints to Formhuby application (see the source code here), which is currently under active development.
This project is under active development, it means that new features a being backed at meanwhile and to catch all them please refer to the front-end app repository here.
- Node.JS - Javascript runtime.
- Typescript - a superset language of Javascript that provides typechecking.
- Docker - for application containerization and ease deployment.
- PostgreSQL - database for storing data.
- Express.js - a small unpinionated framework for building server apps with Node.js
- Jest and Supertest - for testing.
- TypeORM - an ORM for conneting application to PostgreSQL.
- Swagger Docs - for API documentation.
Make sure you have installed Node.js (v20.9.0 or later recommended) which also comes with npm v10.1.0.
In the project directory, you can run in terminal:
npm run dev
Runs the app in the development mode and the server will reload when you make changes to the source code.
npm run build
Builds the app for production to the dist folder.
npm run start
Builds and starts the server in prodution.
E-mail: nhantumbok@gmail.com
Github: https://github.com/KainNhantumbo
Portfolio: https://codenut-dev.vercel.app
My Blog: https://codenut-dev.vercel.app/blog
If you like this project, let me know by leaving a star on this repository so I can keep improving this app.😊😘
Best regards, Kain Nhantumbo.
Made with ❤ Node.js, Express.js and Typescript
Licensed under Apache License 2.0. All rights reserved.
Copyright © 2023 Kain Nhantumbo.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.