Giter Club home page Giter Club logo

membership-portal's Introduction

membership-portal

The ACM Membership Portal repo contains the backend for the ACM Membership Portal website.

Overview

This repo uses the following main technologies:

  • ExpressJS
  • Postgres
  • GoogleAuth
  • Docker (for development)
  • Jest (for testing)

The backend source code can be found in the 'app' directory. The routes for the backend are found in 'app/api/v1'. The unit tests can be found in the 'tests' directory.

Prerequisites

To run this repo for development or testing, you need to have Docker installed.

Development

Development mode is where you should code and test new features. In development mode, a docker container for the database and the backend API are created and ran. Any saved changes to a file will automatically recompile the server code.

To run in development:

$ make

Testing

To run unit tests:

$ make test

This command will create and run the database and run all the unit tests.

Accessing the Server

The server runs on port 8080.

You can test that the server is running by going to http://localhost:8080/api/v1/health. If the server is running on a computer that is not your development computer, the address will be http:<IP ADDRESS>:8080/api/v1/health, where IP ADDRESS is the address of the server.

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.