Code Monkey home page Code Monkey logo

gotcha-api-techbash's Introduction

Gotcha! API

The Elixir Phoenix API for playing Gotcha! Gotcha. Gotcha where I want cha.

DESCRIPTION

This is the code for the server-side API application for the Gotcha game. It is built using Absinthe and it is powers the Gotcha React Native application.

INSTALLATION

This project was created using Elixir, Phoenix, and Absinthe.

There are a few pre-requisites that you need to get started.

brew install node
brew install elixir
brew install postgresql
brew services start postgresql
mix archive.install hex phx_new 1.5.12

Then clone or fork this repo.

git clone https://github.com/jwright/gotcha-api-techbash.git

Get the dependencies

cd gotcha-api
mix deps.get

Setup the database

mix ecto.setup

RUNNING

You can run the Phoenix server with the following:

mix phx.server

The application will run on port 4000 by default so you can access the web app at http://localhost:4000.

Running Tests

ExUnit is the test framework that was used for this application.

To run all of the tests for this application, you can run the following within the root directory.

mix test

CONTRIBUTING

  1. Fork the repository hub fork https://github.com/jwright/gotcha-api-techbash.git
  2. Create a feature branch git checkout -b my-awesome-feature
  3. Codez!
  4. Commit your changes (small commits please)
  5. Push your new branch git push origin my-awesome-feature
  6. Create a merge request hub pull-request -b jwright:main -h <your-account>:my-awesome-feature

gotcha-api-techbash's People

Contributors

jwright 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.