Code Monkey home page Code Monkey logo

anchor-tcm-m5's Introduction

⚓ Anchor API

Description

Project to facilitate event users and event creators to manage events, from the place where the event took place to the purchase of a ticket.

ANCHOR YOUR TIME IS WORTH MORE WITH OUR EVENTS!

Main features

  • Separated dev and production settings

  • Example app with custom user model

  • Bootstrap static files included

  • User registration and logging in as demo

  • Heroku for easy deployments

  • Separated requirements files

  • SQLite by default if no env variable is set

💻 Prerequisites

Before starting, make sure you've met the following requirements:

  • You have installed the latest version of <python> and <pip>

🚀 Install Anchor-API

To install Anchor, follow these steps:

The first thing to do is to clone the repository:

$ git clone https://github.com/matheusprado1/anchor-tcm-m5.git
$ cd anchor-tcm-m5

Create a virtual environment to install dependencies in and activate it:

$ virtualenv2 --no-site-packages env
$ source env/bin/activate

Then install the dependencies:

(env)$ pip install -r requirements.txt

Note the (env) in front of the prompt. This indicates that this terminal session operates in a virtual environment set up by virtualenv2.

Once pip has finished downloading the dependencies:

(env)$ cd project
(env)$ python manage.py runserver

And navigate to http://127.0.0.1:8000/api/.

Website with documentation with api swagger

https://anchor-tcm-m5.herokuapp.com/schema/swagger-ui/

📫 Contributing to Anchor-API

To contribute to AnchorApi, follow these steps:

  1. Fork this repository.
  2. Create a branch: git checkout -b <branch_name>.
  3. Make your changes and commit them: git commit -m '<commit_message>'
  4. Push to the original branch: git push origin <branch_name> / <local>
  5. Create the pull request.

Alternatively, see the GitHub documentation at How to create a pull request.

Libraries used in the api

[Django-rest-framework][https://www.django-rest-framework.org/]

[Django-filter][https://django-filter.readthedocs.io/]

[Cloudinary][https://cloudinary.com/]

[Geopy][https://geopy.readthedocs.io/]

Deploy Website

https://anchor-tcm-m5.herokuapp.com/

🤝 Collaborators

We thank the following people who contributed to this project:

Amanda Oliveira
Dev
Caio Giffoni
Product Owner
Jaqueline Malinoski
Dev
Matheus Prado
Tech Lead
Paulo David
Dev
Talitta Nunes
Scrum Master

anchor-tcm-m5's People

Contributors

matheusprado1 avatar paulo-david avatar caiogiffoni avatar jaquemalinoski avatar amandaolits avatar talitta-nunes avatar

Watchers

 avatar

Forkers

amandaolits

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.