Git Product home page Git Product logo

atom-documentation's Introduction

Atom-documentation

About

Atom is a communication portal that helps us in recording and maintaining all the team events/projects. We also have a user management portal where there are 4 roles. User, member, admin, super admin. People can be promoted/demoted between these roles.

Table of content

  1. Feature
  2. Demo
  3. Contribution
    1. How to run it locally
    2. Fundamentals
  4. Style and customization
  5. Road map
  6. Feedback

Features

Member-

  1. They can preview the upcoming task
  2. They can mark their progress in the task that is assigned in the porta

Non-Member-

  1. They can keep track of the club events
  2. Information Regarding Recruitments would also be displayed for non-members

Admin-

  1. They are responsible for adding
    1. Task for members
    2. Events and recruitments update for both members and non members
  2. They can also promote a non member to a member

Super-Admin-

  1. Have similar functions of an admin
  2. They have an additional feature of promoting a member to an admin

Demo

Video

Contributions

The fundamentals are

  1. Fork the project & clone locally.
  2. Create an upstream remote and sync your local copy before your branch.
  3. Branch for each separate piece of work.
  4. Do the work, write good commit messages, and read the CONTRIBUTING file if there is one.
  5. Push to your origin repository.
  6. Create a new PR in GitHub.
  7. Respond to any code review feedback.

Run Locally for Development

  • Clone your forked repository.
  • Run npm install in the root directory.
  • Run npm start or npm run dev to start the server.
  • In your browser of choice, go to localhost:5000 to see the website.

Style and Customization

Feedback

Note: Contact @arindamlahiri for the environment variables configuration

atom-documentation's People

Contributors

kumarrohan9724 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.