Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devsargam/internsathi-api
API for internsathi - internship Application Management System
https://github.com/devsargam/internsathi-api
docker express mongo mongoose node typescript
Last synced: 13 days ago
JSON representation
API for internsathi - internship Application Management System
- Host: GitHub
- URL: https://github.com/devsargam/internsathi-api
- Owner: devsargam
- License: mit
- Created: 2023-06-15T10:45:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-18T17:58:58.000Z (3 months ago)
- Last Synced: 2024-12-03T03:31:56.700Z (21 days ago)
- Topics: docker, express, mongo, mongoose, node, typescript
- Language: TypeScript
- Homepage:
- Size: 569 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Internsathi-API
API for internsathi - internship Application Management System
# 🚀 Getting Started
## Requirements
- Docker
or
- Node.js
- MongoDB
- Yarn
## ⬇️ Installation
### With docker
Click Me
1. Clone the repository
2. Use docker-compose to run the server
```bash
git clone [email protected]:devsargam/internsathi-api.git
docker-compose up
```
### without docker
Click Me
1. Clone the repository
2. Install the dependencies
3. Fill the necessary environment variables (see .env.example)
4. Run the server
```bash
git clone [email protected]:devsargam/internsathi-api.git
cd internsathi-api
cp .env.example .env
yarn
yarn dev
```
## 📝 Documentation
Use [insomnia](https://docs.insomnia.rest) to test the API
import [config](Insomnia_internsathi_API.json) to insomnia project then explore different routes
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.