Git Product home page Git Product logo

freeagent's Introduction

FreeAgent

FreeAgent is for professional athletes looking to make their mark in the world of track & field. FreeAgent helps you find meets in your area, provides registration information, and allows you to track and share your personal records with potential sponsors.

Utilizing

  • React
  • Redux
  • Node.js
  • MongoDB
  • Mongoose

Server

To set up the API on your computer:

  • create a new MongoDB database called free-agent. The collections will be created by the schema models when you run the application.
  • run this in CLI from the /client/src/data folder to import meet data into database: mongoimport --db free-agent --collection meets --file allMeets.json
  • run this in mongo to set search fields in data: db.meets.createIndex({ name: "text", venue: "text", city: "text", state: "text", country: "text", abbrev: "text", cost: "text"})

Endpoints

All server endpoints are routed through /api. Beyond that, there is a specific path for each main API function:

  • /auth for registration and login
  • /user for user CRUD
  • /result for user result CRUD
  • /meet for meet CRUD (Admin only)
  • /meet/save for saved/scheduled meet CRUD
  • /team for user team CRUD

In most cases, the _id for the entry will be added after the endpoint above, e.g. /user/:userId.

Depending on the situation, a dynamic id endpoint might be added following the appropriate category mid path, e.g. /meet/:meedId/save/user/:userId.

Client

On the client side, there are three main users for the site: unregistered users, registered users, and admins.

User Types:

Unregistered users

Unregistered users are able to visit the site, set their locations, and make execute search queries to find meets in their area. They may also view a user's profile, if that user has set their profile to publicly viewable.

Registered users

Registered users may do all that unregistered can, and can also make personal profiles, toggle privacy on those profiles, as well as input user-specific information about their track and field records, upcoming events, and saved events.

Admins

Upon login, admins can view a dashboard that allows them to view different data sets from the site. They can CRUD both meets and users from the front end, as well as view the number of meets and users on the main dashboard.

Endpoints

All client endpoints are listed below.

  • / home page of the site
  • /login for user login
  • /register for user registration
  • /dashboard User Dashboard for editing account information
  • /:username to view a user's profile

freeagent's People

Contributors

imanioliver avatar seanmcp 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.