Giter VIP home page Giter VIP logo

mvp's Introduction

CSTP 2107 Internet Programming and Web Apps

MVP Project

Authors

Abbe AzaleKarla BarreraYifei ChenAngelo GuerraEmil SangilSon Minh NguyenRyan Urbien

📔 Table of Contents

🌟 About the Project

MVP is a web app specially designed to connect sports lovers in seconds through fun, competitive matches. With a streamlined design to simplify the game process and the ability to input users' team wins, they can work their way to the top of our leaderboard.

This is a Next.js project bootstrapped with create-next-app.

👾 Tech Stack

  • react
  • next
  • sass
  • mongodb
  • moongoose
  • tailwind
  • cloudinary
  • mapbox

🎯 Features

  • Ability to quickjoin a match with the click of a button
  • Ability to search through matches by sport and username
  • Ability to create matches and input scores

🎨 User Interface Reference

Color

Color Hex
Primary Color #FC5C3E
Background Color #F6F6F6
Secondary Color #7A7A7A
Tertiary Color #A4A4A4
Dark #172123
Font #F6F6F6

Font Family

Font Description
Charm Google Font

📁 Folder Structure

  1. public - icons and images go here

  2. src - source folder where below folders are contained

  3. components - resuable components for buttons and nav, etc.

  4. context -

  5. hooks - react hooks

  6. lib - libraries

  7. pages - the pages our the app

  8. shared -

  9. stories -

  10. styles - the style modules for pages and components

  11. types -

📝 Getting Started

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

🏃 Run Locally

  1. Clone or download the project repository
  2. In your terminal, do npm i and then
npm run dev
# or
yarn dev

to run the development server!

👥 Contributing

Contributions are always welcome and appreciated. Please ensure to always make a new branch for your additions.

©️ License

Distributed under the MIT License. See LICENSE.md for more information.

📌 References

mvp's People

Contributors

sonminhnguyen2000 avatar emilsangil avatar razielgelo avatar dmncrynn avatar karla-bot avatar melodyc823 avatar abbeazale 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.