https://github.com/ruffinweb/ruffinweb-portfolio-backend
Portfolio application to make my projects and info about me more easily accessible to the world. This repo contains the Django and Django Rest Framework files.
https://github.com/ruffinweb/ruffinweb-portfolio-backend
Last synced: 10 months ago
JSON representation
Portfolio application to make my projects and info about me more easily accessible to the world. This repo contains the Django and Django Rest Framework files.
- Host: GitHub
- URL: https://github.com/ruffinweb/ruffinweb-portfolio-backend
- Owner: ruffinweb
- Created: 2024-01-26T14:40:42.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-07T00:18:28.000Z (about 2 years ago)
- Last Synced: 2025-02-23T21:29:25.470Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 3.65 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ruffinweb Backend
This project serves as the portfolio for Elijah Ruffin, showcasing his work as a full-stack developer. The backend consists of simple Message and Sender models for storing information submitted by users.
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [API Documentation](#api-documentation)
- [Contributing](#contributing)
- [License](#license)
## Introduction
This project is for displaying information about me as a full-stack developer. The current backend is very simple with Message and Sender models for storing information submitted by users.
## Features
- Contact form
- Automatic email replies
## Technologies Used
- Django
- Django REST Framework (DRF)
- PostgreSQL
## Getting Started
To get started with this project locally, follow these steps:
### Prerequisites
Make sure you have the following prerequisites installed on your machine:
- Python 3.x
- pip (Python package installer)
- PostgreSQL
- Git
### Installation
BLOCK
1. Clone the repository to your local machine:
```bash
git clone https://github.com/ruffinweb/Ruffinweb-Portfolio-Backend.git
```
2. Navigate to the project directory:
```bash
cd RuffinwebProject
```
3. Create and activate a virtual environment:
```bash
python3 -m venv venv
source venv/bin/activate
```
4. Install the project dependencies:
```bash
pip install -r requirements.txt
```
5. Set up the PostgreSQL database:
- Create a new PostgreSQL database for the project.
- Update the database settings in `settings.py` with your PostgreSQL credentials.
6. Run database migrations:
```bash
python manage.py migrate
```
7. Start the development server:
```bash
python manage.py runserver
```
8. Open your web browser and navigate to [http://localhost:8000](http://localhost:8000) to access the application.
## Usage
Visit https://ruffinweb.com to view/use my website!
## API Documentation
API documentation will be available soon.
## Contributing
Feel free to submit a pull request or clone this repository for your own non-commercial application.
## License