Code Monkey home page Code Monkey logo

data's Introduction

Freesewing data

Freesewing is an online platform to draft sewing patterns based on your measurements.

This is the data repository, which holds the source code for our data API.

For all info on what freesewing does/is/provides, please check the about page or documentation.

About

The website, freesewing.org, uses a JAMstack architecture.

JAMstack is a modern web development architecture based on client-side JavaScript, reusable APIs, and prebuilt Markup.

What that means is that our site is statically generated HTML. That's great for documetation and so on, but when you want it to do useful stuff (like drafting sewing patterns), you need an API to talk to with JavaScript.

This repository holds the API for all user data. It handles things like authentication, user details, models, and pattern data. It essentially does everything except generating patterns. That is handled by our core API.

This data API is written in PHP on top of the Slim framework. It uses JSON web tokens with slim-jwt-auth as authentication middleware.

System Requirements

To run your own instance of this API, you'll need:

  • PHP 5.6 or above (we recommend PHP 7)
  • composer
  • A database (we use MySql/MariaDb)

Installation

Full install instructions are available at freesewing.org/docs/data/install but here's the gist of it:

git clone [email protected]:freesewing/data.git
cd data
composer install
composer dump-autoload -o

License

This code is licensed GPL-3, the pattern drafts, documentation, and other content are licensed CC-BY.

Contribute

Your pull request are welcome here.

If you're interested in contributing, I'd love your help. That's exactly why I made this thing open source in the first place.

Read freesewing.org/contribute to get started. If you have any questions, the best place to ask is the freesewing community on Gitter.

data's People

Contributors

joostdecock avatar

Watchers

James Cloos avatar Michael Hall avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.