Code Monkey home page Code Monkey logo

plutarchus's Introduction

Plutarchus

Read full documentation: https://github.com/ayushpatnaikgit/plutarchus/blob/master/docs/USER_DOC.pdf

Plutarchus is an open source personal website building tool. It takes a JSON file and generates a website using the data in the JSON file. The JSON file is the dataset of the user's work. The websites that Plutarchus generates are static HTMLs, however Javascript and CSS are integrated to make then at par with modern web designs. Plutarchus v0.1 is designed to build resume websites. The examples and test cases are websites of academics and hence same are the target audience for v 0.1.

How to use

  1. Construct the dataset of your work in a JSON file by editing assets/basic_format.json
  2. Either use the commandline interface or the web app to construct the website by supplying the JSON file.

Making JSON File

There should be a settings section and an entries section in the JSON. The format is provided in assets/basic_format.json

The settings section contains basic information such as name of the user, theme, email address of the user, page names, etc.

The entries section contains all the dataset of the users work and the home page.

Command Line Interface

$ git clone https://github.com/ayushpatnaikgit/plutarchus.git If you JSON file is name example.JSON and it is in the plutarchus folder, run $ python src/plutarchus.py example.JSON. If your JSON file is elsewhere, write the path instead of just 'example.json' this will generate a folder names 'template'. This is your website. Open index.html to view it.

Graphical User Interface (web app)

Go to plutarchus.com to view the web app. upload the JSON file. Download and unzip the file shown in the prompt. You will see a folder 'template'. This is your website. Open index.html to view it.

plutarchus's People

Contributors

ayushpatnaikgit avatar anshultayal498 avatar tayal314 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.