Giter VIP home page Giter VIP logo

atlas's Introduction

Welcome

Atlas is an E-Commerce Backend (RESTful) API.

It was built with the Yoonic E-Commerce Storefront application in mind and you can check it out live powering NICI Store!

Why write plugins when you can build your own e-commerce platform?

Swagger API Documentation

API Resources

After deploying and running Atlas locally, you can access the Swagger API Documentation by browsing to localhost:8000/docs.

Overall, Atlas provides services for:

  • User Accounts
  • Contents
    • Homepage Banners
    • Articles
    • Content common to all Product Pages
    • ... <-- Whatever you wish :)
  • Products
  • Collections
    • Products
    • Contents
    • Customers
    • ... <-- Your own segmentation engine!
  • Carts
  • Checkouts
  • Orders

Batteries Included

Storefront has a few more tricks up its sleeve ;)

Requirements

Installation

In order to setup, run and start hacking the app locally you just have to:

  1. Clone this repository
  2. npm install
  3. Start rethinkdb server and, in a browser, navigate to http://localhost:8080/#tables (RethinkDB admin)
  4. Create a database named atlas
  5. In that database, create the following tables:
  • Carts
  • Checkouts
  • Collections
  • Contents
  • Orders
  • Products
  • Users
  1. Create a JWT secret key (e.g. using openssl rand -base64 32) and either:
  • Setup the env variable JWT_KEY
  • Add it to the configuration file at config/development in app.jwtKey
  1. In the directory of the Atlas clone, run npm run dev

At this point, you should be have your local deploy of Atlas running on http://localhost:8000 and can point your local deploy of Storefront to it.

Admin Account

In order to access Storefront's Admin and perform certain API calls, an Administrator account is required.

  1. Create an account (either via the API or Storefront)
  2. In a browser, navigate to http://localhost:8080/#dataexplorer
  3. Run the following query r.db('atlas').table('Users').filter({email: '{YOUR_USER_EMAIL}'}).update({status: 'active', scope: ['admin']}); (don't forget to replace {YOUR_USER_EMAIL} with the email address of the account you created)

Contacts

Comments, suggestions, doubts, flames, /dev/random, etc...

atlas's People

Contributors

andrecrt avatar

Watchers

 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.