Skip to content

Latest commit

 

History

History
94 lines (61 loc) · 4.35 KB

README.md

File metadata and controls

94 lines (61 loc) · 4.35 KB

project chat License: GPL v3 Open Source Love Maintenance PRs Welcome Docs

Anitab-Forms (Frontend)

Anitab-Forms is an application that simplifies the processing and selection procedure of Open Source Programs of AnitaB.org Open Source or other third-party programs. This is the Front-end repo for anitab-forms.

Tech Stack

  • ReactJS
  • Redux

Documentation

Documentation for the project is hosted here. We use Docusaurus for maintaining the documentation of the project.

Roadmap

View project Roadmap here

Setup

  • To setup the project locally go through this wiki page.
  • Here's a video tutorial which will help to setup the project locally.

Note: Before setting up the frontend make sure to have Setup the Backend Repo.

  1. To start the server:
cd anitab-forms-web
npm install
npm start
  1. Navigate to http://localhost:3000/ in your browser.
  2. You can terminate the process by Ctrl+C in your terminal.

Contributing

Please read the Contributing guidelines, Code of Conduct and Reporting Guidelines

Remember to run eslint and prettier before pushing the changes.

To run eslint

npm run lint:fix

To format files

npm run format

Pre-commit hooks

Husky is currently used for running a pre-commit hooks before you make any commits locally, this ensures that tests and linting is passing before the changes are pushed to the branch.

Contributors

Thanks goes to these people (emoji key):


Sankalp

🚧

Shipra Verma

🚧

Kesha K. Kaneria

🚧

This project follows the all-contributors specification. Contributions of any kind welcome!

Contact

You can reach the admins, maintainers, and our community on AnitaB.org Open Source Zulip. If you are interested in contributing to the OSP project, you may join the stream #open-source-progs and ask questions or interact with the community. Join Us!

License

Open Source Programs project is licensed under the GNU General Public License v3.0. Learn more about it in the LICENSE file.