MASQUE 🎭

- API -

||| This project is a Work In Progress |||

A "social" media platform with the goal of complete anonymity of users.

---

The Masque platform uses an API built in Ruby on Rails, for mobile devices - the front end is built using React-Native with plans to build a standard web version using React in the future.

• 📋 Requirements

  The requirements for running this application locally are the same as any Ruby on Rails application (requiring both ruby and the rails gem).

• 🎉 Installation and setup

  Once this repository is cloned, dependencies must be met through:

    bundle
  

  Prior to running the local server, databases will need to be setup and seeded:

    rake db:create db:setup db:migrate
  

  To run the API locally simply run:

    rails s
  

  This will start the dev server on port 3000 by default, which can then be connected to on your local machine for requests.

• 📖 Documentation

  • ✔️ Testing

    rspec is used for testing the API. These tests can be ran with rails spec. At a later date these will be factored into a CI system.

  • 🚧 Structure

    This project follows the basic MVC setup following your standard rails project setup.

  • 🚗 Routing

    The breakdown for the routes of the api can be found on the /api path.

  • ⚛️ Front-end

    Currently there is only a mobile front end with plans for a web front-end to be completed at a later date.

• ✉️ Contact

  I'm more than happy discuss anything you find on this repo, please feel free to contact me at [email protected] for any discussion or feedback.

• 📄 License

  This project does not carry a license, and therefore all rights are currently reservedd and this project is not open-source. If you wish to modify or redistribute this project please reach out using the email provided above.