Skip to content

gderijp/binsta

Repository files navigation

Binsta // fullstack framework

Binsta is a Fullstack CRUD-application where users can upload and share code snippets with a Instagram-like UI

Build with selfbuild PHP MVC-framework: Twig Templates, RedBeanPHP-ORM and Tailwind CSS

Features

  • User Authentication

    • User registration and login
    • User can update username, password or bio
    • User can upload a profile picture
    • Users can search for other users using the top search bar
  • Code snippets

    • Add, edit and like code snippet posts
    • Users may comment under posts
    • Users may fast-copy code snippets, or:
    • Users may fork snippet posts
    • User can click to the user's profile via the post
    • Posts are labeled through programming language tags
  • Database management

    • Managed by RedBeanPHP-ORM
    • Seeder available for testdata: seeder.php

Tech Stack

  • Backend Framework: Selfbuild PHP MVC-Framework
  • Template Engine: Twig
  • Database ORM: RedBeanPHP
  • Database: MySQL
  • CSS: Tailwind CSS

Installation

  1. Clone this repository
  2. Configure your webserver (like apache), or create a virtual host to point to the public folder
  3. Install dependencies:
composer install
  1. Set up MySQL database:
    • Create a database called 'binsta'
    • Create a .env file by running:
     cp ./.env.example ./.env
    
    • Configure database in .env:
      DB_HOST="localhost"
      // etc...
  2. Seed the database:
    php seeder.php
    

Usage

  1. Serve the application:
php -S localhost:8000 -t public
  1. Start your web server (like apache)

  2. Open the app in your browser: localhost

  3. Default test user's login:

    • Username: test
    • Password: test

    OR:

    • Username: future-tech-leader
    • Password: password
  4. While updating styling in twig templates, run this command for Tailwind CSS to dynamically update styles.css (for development):

./tailwindcss -i ./public/resources/css/input.css -o ./public/resources/css/styles.css --watch

Contributing

Feel free to create issues or pull requests

About

Binsta is a code snippet sharing Fullstack CRUD-application. Built with selfbuild PHP MVC-framework

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors