Skip to content

AdConDev/snippet-box

Repository files navigation

SnippetBox

SnippetBox is a web application that allows users to create, store, and manage code snippets.

Features

  • User authentication and session management
  • CRUD operations for code snippets
  • Dynamic HTML templates for user interface
  • Efficient request routing

Getting Started

Prerequisites

  • Go
  • MySQL

Installation

  1. Clone the repository
git clone https://github.com/consdotpy/snippetbox.git
  1. Install dependencies
go mod download
  1. Set up your MySQL database using the provided SQL scripts in the sql/ directory. Be sure to change credentials in the sql/create_user.sql script before running it.
sudo mysql
source sql/*.sql

Usage

Check .env.example for environment variables that need to be set. Then, run the application using Makefile:

make run

Testing

To run quality control checks, execute:

make audit

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

License

Distributed under the MIT License. See LICENSE for more information.

About

Share or show snippets of code

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •