https://github.com/srish-ty/src-event-server
Backend server for event SRC by AiCHE, NIT Rourkela
https://github.com/srish-ty/src-event-server
Last synced: about 1 year ago
JSON representation
Backend server for event SRC by AiCHE, NIT Rourkela
- Host: GitHub
- URL: https://github.com/srish-ty/src-event-server
- Owner: Srish-ty
- License: mit
- Created: 2024-08-05T15:35:01.000Z (almost 2 years ago)
- Default Branch: feat/backend
- Last Pushed: 2024-08-05T15:38:30.000Z (almost 2 years ago)
- Last Synced: 2025-02-14T18:17:47.829Z (over 1 year ago)
- Language: TypeScript
- Size: 1.35 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](#contributors-)
[](https://github.com/zepfietje/starware)
Project Dates
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
## About
**This is the backend repository for campus guide at NIT Rourkela. It is a respository managing the API for managinng, controlling and authorising the users with respect to the mobile application of Avenue.**
Project developed and maintained by DSC NIT Rourkela
## Tech Stack
This project uses the following technologies :
---
## Local Setup
This section contains the procedure to setup the project on your local machine.
`PREREQUISITE INSTALLATIONS`
> 1. Docker
> 2. Docker Compose
> Node.js required only for linting locally
1. **Fork** the repo on GitHub
2. **Clone** the project to your own machine
3. Prepare the env for project.
`cd api && mv .env.example .env`
4. Add Mongo DB URI in `.env` file
5. Create firebase project and add config variables in `.env`
6. Change dir to api. `cd api`
7. run `yarn generate`
### To run the server:
7. run `yarn run dev`
### To open Apollo Sandbox:
8. go to "http://localhost:8000/graphql"
### To run docker container:
9. Build the docker image
`docker-compose build --no-cache`
10. Spin the server.
`docker-compose up`
---
## Documentation Notes
This section contains a quick guide about the features of the application.
---
## Contributing 🎃
This repository is one of the many repositories maintained by DSC NIT Rourkela NIT Rourkela.
Our Slack Community: [Slack Invite](http://bit.ly/NITRDevs)
Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.
NOTE 1: Please abide by the [Contributing Guidelines](https://github.com/dscnitrourkela/project-dates/blob/development/CONTRIBUTING.md).
NOTE 2: Please abide by the [Code of Conduct](https://github.com/dscnitrourkela/project-dates/blob/development/CODE_OF_CONDUCT.md).
## Starware
`dscnitrourkela/project-dates` is Starware.
This means you're free to use the project, as long as you star its GitHub repository.
Your appreciation makes us grow and glow up. 🌠
## Contributors ✨
Thanks goes to these wonderful people. Check out the roles [here](https://allcontributors.org/docs/en/emoji-key):
Roshan Kumar Shaw
💻 📆 👀
Harish
💻 📆 👀
Abel Mathew
💻 📆
All Contributors
🔧
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
[contributors-shield]: https://img.shields.io/github/contributors/dscnitrourkela/project-dates?style=for-the-badge
[contributors-url]: https://github.com/dscnitrourkela/project-dates/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/dscnitrourkela/project-dates?style=for-the-badge
[forks-url]: https://github.com/dscnitrourkela/project-dates/network/members
[stars-shield]: https://img.shields.io/github/stars/dscnitrourkela/project-dates?style=for-the-badge
[stars-url]: https://github.com/dscnitrourkela/project-dates/stargazers
[issues-shield]: https://img.shields.io/github/issues/dscnitrourkela/project-dates?style=for-the-badge
[issues-url]: https://github.com/dscnitrourkela/project-dates/issues
[license-shield]: https://img.shields.io/github/license/dscnitrourkela/project-dates?style=for-the-badge
[license-url]: https://github.com/dscnitrourkela/project-dates/blob/main/LICENSE