Giter VIP home page Giter VIP logo

DistroBoard

A modern and opensource alternative to distrowatch

OpenIssues ClosedIssues LastCommit Contributors

Project Banner

Notes for developers

Instructions to run application in develpment

  • Install all frontend dependencies
cd DistroBoard/DistroBoard/client
yarn install
  • Install all backend dependencies
cd DistroBoard/DistroBoard/server
yarn install
  • Start the application

Backend

cd DistroBoard/server
yarn dev

Frontend

cd DistroBoard/client
yarn start

Directory Structure

Backend

server/
├── config (consists of the database configuration)
|   |
│   └── db.js 
├── routes (contains declarations for all the routes used by the backend)
|   |
│   └── distros.js
├── controllers (the functionality of all routes are defined here)
|   |
│   └── distros.js
├── index.js (the startpoint of the backend application)
├── models (contains the mongodb schema used by the frontend)
|   |
│   └── distroInfo.js
├── package.json ( a detailed list of all packages used in the backend)
└── yarn.lock (lock file for packages)

Frontend

client/
├── public (the public directory of the frontend, contains basic metadata for the application)
|   |
│   ├── favicon.ico
│   ├── index.html
│   ├── logo192.png
│   ├── logo512.png
│   ├── logo.png
│   ├── manifest.json
│   └── robots.txt
├── README.md (contains documentation on how to use react with yarn package manager)
|   |
├── src (contains the souce code for the frontend)
|   |
│   ├── actions (contains all the actions used by redux)
│   │   └── distros.js
│   └── reducers ( all reducers used by redux are defined here)
│       ├── distros.js
│       └── index.js
│   ├── constants (the constants defined for redux)
│   │   └── actions.js
│   ├── api (all api calls from the backend are declared here)
│   │   └── index.js
|   |
│   ├── App.js (the main component for the application, parent to all other components)
|   |
│   ├── assets (contains all assets used by the application)
│   │   └── images
│   │       ├── attribute.txt
│   │       └── logo.png
|   |
│   ├── components ( contains all reuseable react components)
|   |
│   │   ├── Distros (displays all distros in a grid)
|   |   |   |   
│   │   │   ├── Distro ( a singular distro card) 
│   │   │   │   ├── Distro.js
│   │   │   │   └── styles.js
│   │   │   ├── Distros.js
│   │   │   └── styles.js
│   │   ├── Form (the form used by admins to manage distro information)
│   │   │   ├── Form.js
│   │   │   └── styles.js
│   │   ├── Header (the header bar containing the search bar and other links)
│   │   │   ├── Header.js
│   │   │   └── styles.js
│   │   └── Search ( the search bar used to search distros)
│   │   |    ├── Search.js
│   │   |    └── styles.js
│   │   └── AllDistros (displays all distros in alphabetical order used by react-router)
│   │   |    ├── AllDistros.js 
│   │   └── About (about page used by react-router)
│   │   |    ├── About.js
│   │   |    └── styles.js
│   │   └── Auth (auth page used by react-router)
│   │       ├── Auth.js
|   |
│   ├── index.js (the startpoint of the frontend)
├── package.json (a detailed list of all packages used in the backend)
└── yarn.lock (lock file for packages)

Branch Structure

  • Main - The master branch used for hosting
  • Beta-Stable - Branch containing stable tested features yet to be added to main.
  • Beta-Unstable - Branch based on nightly containing incomplete features yet to be tested and completed.
  • Nightly - All new features originate here. This is an experemental branch.

Key Developers

Contributor Role
VULKAN FullStack Web Dev
Abdellatif-dev Server Guy
NarutoXY FrontEnd Web Dev

Stack

Frontend

Middleware

Backend

Database

DistroBoard's Projects

distroboard icon distroboard

A modern and opensource alternative to distrowatch.

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.