An open API service indexing awesome lists of open source software.

https://github.com/arvind-4/users-task

A straightforward Django app with a Neon database, hosted on Vercel.
https://github.com/arvind-4/users-task

django django-rest-framework neondb postgresql-database vercel

Last synced: 6 months ago
JSON representation

A straightforward Django app with a Neon database, hosted on Vercel.

Awesome Lists containing this project

README

          

# Users API

A straightforward Django app with a Neon database, hosted on Vercel.

## 📦 Tech Stack:
- [Django](https://www.djangoproject.com/) - Django makes it easier to build better web apps more quickly and with less code.
- [Postgres DB](https://www.postgresql.org/) - The World's Most Advanced Open Source Relational Database.
- [Vercel](https://vercel.com/) - Vercel's Front end Cloud provides the developer experience and infrastructure to build, scale, and secure a faster, more personalised Web.

## 📦 Getting Started:

1. Clone the project and make it your own.
```bash
mkdir ~/Dev
cd ~/Dev
git clone https://github.com/Arvind-4/users-task.git
cd users-task
```

2. Create a virtual environment
```bash
python3.10 -m virtualenv .
source bin/activate
```

3. Install Dependencies using pip
```bash
pip install -r requirements.txt -r requirements-dev.txt
```

4. Install Dependencies using poetry
```bash
poetry install
```

5. Copy `sample.env` to `.env`
```bash
cp .env.local .env
```

6. Run server
```bash
bash run.sh
```

## 🐛 Bug Reporting

Feel free to [open an issue](https://github.com/Arvind-4/users-task/issues) on GitHub if you find any bug.

## ⭐ Feature Request

- Feel free to [Open an issue](https://github.com/Arvind-4/users-task/issues) on GitHub to request any additional features you might need for your use case.
- Connect with me on [LinkedIn](https://www.linkedin.com/in/a-arvind/). I'd love ❤️️ to hear from you.

## 📋 Change Log:

Check [here](https://github.com/Arvind-4/users-task/commits/main) for change logs.

## 📜 License

This software is open source, licensed under the [MIT License](https://github.com/Arvind-4/users-task/blob/main/LICENSE).