https://github.com/michalstaszkiewicz/wordy-server
Backend for the Wordy application
https://github.com/michalstaszkiewicz/wordy-server
backend hapi hapi-server hapijs-backend postgresql server typescript
Last synced: about 1 year ago
JSON representation
Backend for the Wordy application
- Host: GitHub
- URL: https://github.com/michalstaszkiewicz/wordy-server
- Owner: MichalStaszkiewicz
- Created: 2023-10-31T09:46:03.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-07T19:08:17.000Z (over 2 years ago)
- Last Synced: 2025-02-07T23:29:10.506Z (over 1 year ago)
- Topics: backend, hapi, hapi-server, hapijs-backend, postgresql, server, typescript
- Language: TypeScript
- Homepage:
- Size: 1.99 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🚀 Wordy Server 🚀
The Wordy Server is the backbone of the
Wordy
application, providing the API endpoints that the Wordy frontend interacts with. Developed using TypeScript and Hapi, the server seamlessly facilitates data exchange and communication between the client and the backend.
## Prerequisites ⚙️
Before diving into the installation and running of the Wordy Server, ensure that you have the following prerequisites in place:
- **Node.js and npm:** Your system must have Node.js and npm installed. If you haven't already, download and install them.
- **PostgreSQL Database:** Set up a PostgreSQL database (e.g., pgAdmin) named 'wordydb'. Create a Postgres user with the username 'postgres' and password '1337'. Ensure the database is running on the default PostgreSQL port, 5432.
## Configuration ⚙️
1. **Create .env file:** In the project directory, create a file named `.env`. This file will hold the sensitive environment variables required for running the server.
```env
NODE_ENV=development
DB_LOGIN = "TYPE_LOGIN_TO_WORDY_DB"
DB_PASSWORD = "TYPE_PASSWORD_TO_WORDY_DB"
DB_HOST = "127.0.0.1"
DB_PORT = "TYPE_YOUR_DB_PORT"
SECRET = "TYPE_YOUR_SECRET_KEY"
```
## Installation and Running 🧰
1. **Repository Cloning:** Clone the Wordy Server repository from GitHub using the command git clone
```sh
https://github.com/MichalStaszkiewicz/wordy-server.git
```
2. **Open a terminal and navigate to the project directory.**
3. **To install the required dependencies run:**
```sh
npm install
```
4. **To start the server in development mode run:**
```sh
npm run dev
```
5. **Server Verification:** Upon successful server startup, you should see the message "Server running at: http://localhost:1344" in the console.
## Documentation 📖
The Wordy Server API documentation is available at the '/docs' endpoint.