Skip to content

Latest commit

 

History

History
320 lines (240 loc) · 12.4 KB

README.md

File metadata and controls

320 lines (240 loc) · 12.4 KB


DNVR Zero

DNVRzero (or Dnvr0) is a modernization of the wildly successful SF0.org

The idea is simple, really: create a user, complete tasks, gain points, level up

The fun comes from the users, and the tasks they invent, and how tasks are interpreted and completed

None of this really means anything, so why not have some fun while doing it?


Logo Thanks Unsplash! | Photo by Pietr Van de Sande
Visit the (archived version of the) original website that is the inspiration for this project »

View Backend source code · View Frontend source code . Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Wireframes
  4. Schema
  5. JSON contracts
  6. Usage
  7. Roadmap
  8. Contributing
  9. License
  10. Contributors
  11. Acknowledgments

About The Project

We're alumni of the Turing School of Software and Design, and this project is part of the New Grad Services program, which provides opportunity for recent grads to continue to practice existing skills, gain new tech stack, and build community around an open source project.

Click for more

We're (re)creating (or re-vitalizing) a site that encourages non-consumer leisure activities, creativity and exploring the habitat in which you find yourself. Create a "player", find a task to complete, and then sign up for that task. Submit proof once you're done and gain sweet, sweet fake internet points to level up.

If you'd rather invent tasks for people to complete, do that too! Date ideas? Solo dates? Artist's date? Looking for a cure for your boredom? Want to meet people and explore your city? Want to do something fun with a loved one? Want to break the monotony of the same ol' routine? What are you waiting for?

Collaborate with your friends! Collaborate with strangers! Or just complete these on your own.

(back to top)

Built With

  • MongoDB
  • Express
  • React
  • Node
  • TypeScript
  • Bootstrap

(back to top)

Getting Started

Prerequisites

  • Must have Node and NPM on your machine

Installation

  • Depending on which branch you're looking to work on, navigate the either the frontend or backend repository
  • fork the repository
  • clone your fork onto your local machine
  • cd into the new repo
  • install the necessary packages with
> npm install

(back to top)

Wireframes

LogIn Page Wireframe

Logo

Main Page Wireframe

Logo

Player Profile Wireframe

Logo

Task Details Wireframe

Logo

Task Holder Wireframe

Logo

(back to top)

Schema

Logo

(back to top)

JSON contracts

The backend repository is using Swagger to help document the endpoints.

Once the backend repo has been forked, cloned and packages have been installed, run the following command to start the development environment:

> npm run start:dev

now navigate to localhost:8000/apidocs and you'll see the Swagger UI

(back to top)

Usage

Coming soon!!

This project will be live; Locating the live site will be listed here, when available; if you're interested in helping with the DevOps of this project, please drop us a line!

(back to top)

Roadmap

This project is managed via the organization project board, which can be found here

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the respective repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the specific organization repo (frontend or backend)
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

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

(back to top)

Contributors

FRONTEND

Jordan Farelli Ali Nix
github GitHub
linkedin LinkedIn
github GitHub
linkedin LinkedIn

BACKEND

Mostafa Sakr Michael Marchand
github GitHub
linkedin LinkedIn
github GitHub
linkedin LinkedIn

(back to top)

Acknowledgments

Some great tools and/or people who helped to make this project what it is!

(back to top)