|
1 | 1 | # Upay
|
| 2 | + |
2 | 3 | [](#contributors)
|
3 | 4 |
|
4 |
| -Description: The foundation of development for every society is the education of its youth. Keeping this in mind, an NGO UPAY (Underprivileged Advancement by Youth), was established in May 2010 by a group of young engineers from IITs and NITs. It mainly aims to provide opportunities to underprivileged children and bring some sunshine in those deprived lives. Ever since it's dawn, UPAY Team has been working wholeheartedly in achieving this aim. Its success story can be culminated by the mere fact that where children were unable to do basic arithmetic calculations are now, not just producing excellent academic results but also bringing laurels to these underprivileged areas. The main vision of UPAY is overcome disparities in education so that every child gets an opportunity to Learn, Grow and Succeed. |
| 5 | +The foundation of development for every society is the education of its youth. Keeping this in mind, an NGO UPAY (Underprivileged Advancement by Youth), was established in May 2010 by a group of young engineers from IITs and NITs. It mainly aims to provide opportunities to underprivileged children and bring some sunshine in those deprived lives. |
| 6 | + |
| 7 | +Ever since it's dawn, UPAY Team has been working wholeheartedly in achieving this aim. Its success story can be culminated by the mere fact that where children were unable to do basic arithmetic calculations are now, not just producing excellent academic results but also bringing laurels to these underprivileged areas. The main vision of UPAY is overcome disparities in education so that every child gets an opportunity to Learn, Grow and Succeed. |
5 | 8 |
|
6 |
| -Tech Stack: Node.js, Javascript, Html, css, Django, Python, Android, Core Java, Angular, React |
| 9 | +Tech Stack: [Next.js](https://nextjs.org/) (NodeJS, ReactJS), ExpressJS server. |
7 | 10 |
|
8 | 11 | Admin: Shagufta Gurmukhdas
|
9 |
| -Mentors: Nupur Baghel , Sambhav Jain, Divjot Singh, Gaurav Sitlani,Bhavin Jawade |
| 12 | +Mentors: Nupur Baghel, Sambhav Jain, Divjot Singh, Gaurav Sitlani, Bhavin Jawade |
| 13 | + |
| 14 | +## Building |
| 15 | + |
| 16 | +Make sure you've NodeJS 8 and NPM 5.7 or above. |
| 17 | + |
| 18 | +```bash |
| 19 | +# install dependencies using npm |
| 20 | +npm ci |
| 21 | + |
| 22 | +# start project in development mode |
| 23 | +npm run dev |
| 24 | + |
| 25 | +# build project |
| 26 | +npm run build |
| 27 | + |
| 28 | +# start project in production mode (after build) |
| 29 | +npm start |
| 30 | + |
| 31 | +# test project |
| 32 | +npm run test |
| 33 | +``` |
| 34 | + |
| 35 | +## Contribution |
| 36 | + |
| 37 | +- Use `npx all-contributors-cli add <your-github-handle> <code|docs|...>` to add yourself in the Contributor list below. The project follows [all-contributors](https://github.com/kentcdodds/all-contributors) format. |
| 38 | +- [VSCode](https://code.visualstudio.com/) is recommended as the editor for this project. |
| 39 | +- Please install [prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode), [eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint), [jest](https://marketplace.visualstudio.com/items?itemName=Orta.vscode-jest) [plugins](https://marketplace.visualstudio.com/) for VSCode for improved developer experience. |
| 40 | +- Please follow [JSDoc](http://usejsdoc.org/) for your submitted code. Use [DocumentThis](https://marketplace.visualstudio.com/items?itemName=joelday.docthis) plugin if required. |
| 41 | +- Write tests for complicated components and modules. |
10 | 42 |
|
11 | 43 | ## Contributors
|
12 | 44 |
|
13 | 45 | Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
|
14 | 46 |
|
15 | 47 | <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
16 | 48 | <!-- prettier-ignore -->
|
17 |
| -| [<img src="https://avatars3.githubusercontent.com/u/6177621?v=4" width="100px;"/><br /><sub><b>Divjot Singh</b></sub>](http://bogas04.github.io)<br />[💻](https://github.com/Shagufta Gurmukhdas/Upay/commits?author=bogas04 "Code") | |
| 49 | +| [<img src="https://avatars3.githubusercontent.com/u/6177621?v=4" width="100px;"/><br /><sub><b>Divjot Singh</b></sub>](http://bogas04.github.io)<br />[💻](https://github.com/GirlScriptSummerOfCode/Upay/commits?author=bogas04 "Code") | |
18 | 50 | | :---: |
|
| 51 | + |
19 | 52 | <!-- ALL-CONTRIBUTORS-LIST:END -->
|
20 | 53 |
|
21 |
| -This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome! |
| 54 | +This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome! |
0 commit comments