Code Monkey home page Code Monkey logo

wordy-server's Introduction

๐Ÿš€ 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.
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
https://github.com/MichalStaszkiewicz/wordy-server.git
  1. Open a terminal and navigate to the project directory.
  2. To install the required dependencies run:
  npm install
  1. To start the server in development mode run:
npm run dev
  1. 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.

wordy-server's People

Contributors

michalstaszkiewicz avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.