Git Product home page Git Product logo

dvanmali / www.surrealdb.com Goto Github PK

View Code? Open in Web Editor NEW

This project forked from koakh/surrealdbhomepageanddocs

0.0 1.0 0.0 183.56 MB

The website, blog, and documentation for SurrealDB, built using Ember.js

Home Page: https://www.surrealdb.com

License: Apache License 2.0

Shell 1.20% JavaScript 5.60% Python 0.22% C 0.01% Java 0.06% Groovy 0.01% Go 0.34% TypeScript 0.22% Makefile 0.30% HTML 0.16% Handlebars 83.87% SCSS 7.48% C# 0.54%

www.surrealdb.com's Introduction

www.surrealdb.com

The web application for surrealdb.com built using Ember.js.

Contributing

Every contribution is welcome! Here is some basic information on how to get started with running and changing the SurrealDB website locally for development.

  • Make sure you have node & npm installed on your system (Here's a great guide by NPM!)
  • Clone the repository, optionally your own fork
    • Via HTTPS: git clone https://github.com/USERNAME/www.surrealdb.com
    • Via SSH: git clone [email protected]:USERNAME/www.surrealdb.com
  • Install dependencies
    • npm install
  • Start the development version of the website
    • npm run start
  • After the process started, you can access the website at: http://localhost:4200

Where can I find what?

  • Pages are stored in app/templates
  • Snippets are often stored in app/snippets

Adding a new page

  • Add your page in app/templates
  • Add the route in app/router.js
  • Add the route in possible sidebars/overview pages/etc...

Add a language for code highlighting

Most languages should be available out of the box. Please adjust the files accordingly:

  • app/initializers/prism.js
  • app/instance-initializers/marked.js

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.