https://github.com/xtt28/onepage
Amplifying the voices of diverse creators worldwide: build your online presence with one page for all of your profiles. Grow your small business or social media page with your own, personalized platform.
https://github.com/xtt28/onepage
Last synced: 5 months ago
JSON representation
Amplifying the voices of diverse creators worldwide: build your online presence with one page for all of your profiles. Grow your small business or social media page with your own, personalized platform.
- Host: GitHub
- URL: https://github.com/xtt28/onepage
- Owner: xtt28
- License: mit
- Created: 2024-03-19T23:10:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-27T22:46:06.000Z (over 2 years ago)
- Last Synced: 2024-03-28T00:37:06.318Z (over 2 years ago)
- Language: Python
- Homepage:
- Size: 92.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OnePage
Amplifying the voices of diverse creators worldwide: build your online presence
with one page for all of your profiles. Grow your small business or social media
page with your own, personalized platform.
## Screenshots
## Description
OnePage is a platform that allows you to combine all of your online links into
one page. By providing a single place for your whole online presence, OnePage
will help you connect with your audience in a professional manner.
## Features
- Built-in support for multiple online platforms
- Allows linking to your own website
- Fast and easy registration and setup
## Getting started
### Cloning the repository
```shell
# Clone from GitHub
git clone https://github.com/xtt28/onepage
# Use repository directory
cd onepage
```
### Activating the virtual environment
```shell
# Setup virtual environment
python3 -m venv .
# Use virtual environment shell
source bin/activate
```
### Installing dependencies
```shell
# Install from requirements.txt
pip install -r requirements.txt
```
### Development
#### Switching to the Django project directory
```shell
# Open Django project directory
cd onepage
```
#### Running the tests
```shell
# Run tests with Django
./manage.py test
```
#### Applying migrations
```shell
# Run all database migrations
./manage.py migrate
```
#### Running the development server
```shell
# Run the development server
./manage.py runserver
# Will be accessible at http://localhost:8000
```
### Production
#### Set environment variables
By default, the project uses the `SECRET_KEY` environment variable for the
Django secret key. Set it with:
```shell
# Set SECRET_KEY environment variable
export SECRET_KEY=your_key
```
#### Collect static files
```shell
# Collect static files into the prod_static directory
./manage.py collectstatic
```
#### Preparing for deployment
Please refer to the Django [deployment checklist](https://docs.djangoproject.com/en/5.0/howto/deployment/checklist/)
for detailed instructions on deployment. You can run an automated check with:
```shell
# Automated pre-deployment check
./manage.py check --deploy
```
## Technology
### Frontend
- [Pico CSS](https://picocss.com/)
- [htmx](https://htmx.org)
### Backend
- [Django](https://www.djangoproject.com/)
- [SQLite](https://sqlite.org)
## Contributing
Contributions are always welcome. Please:
1. Write tests for your code.
2. Format your code with `black`.
## License
[MIT](https://choosealicense.com/licenses/mit/)