Giter VIP home page Giter VIP logo

sphil's Introduction

๐Ÿšง This is a work in progress

If you'd like to be part of the development of sPhil, kindly follow the instructions below. If you have any further questions or would like to get involved, get in touch with Firgrep here.

Setting up your local environment and branch

0.0. Once you have access to the repo on github, fork and/or clone it into a folder where you keep your projects.

0.1. Then cd sphil to get into the project directory.

0.2. Make your own development branch git branch dev-<your-name> (example: git branch dev-tim).

0.3. Set the newly made development branch as the current active branch, run git checkout <your-branch-name>.

0.4. In future, when getting the latest changes from the main development branch, run git merge dev whilst on your development branch to incorporate the changes into your branch.

Packages Installation

1.0. Once inside, run npm i (alias npm install) to install all the packages. This will create the /node_modules folder.

Environmental Variables

2.0. There are no environmental variables! This is a static website. (Caveat: we defined some public variables depending on where the site is hosted.)

Running the Server

9.9. Finally, to start a local development server, run npm run dev and open up http://localhost:3000 on your favorite browser.

  • Whenever you make any edits to the source files while the server is running, the server will pick up those changes and output them immediately. This is extremely handy during development, as you can input code and hit ctrl + k then s (save-all) and view directly your latest changes.
  • To terminate the server, hit ctrl + c on your keyboard whilst in the terminal where the server runs, input y when prompted to terminate batch job.

โ— You may get an error (e.g. useRef is null) as your development server refreshes. This is likely due to how nextra processes the mdx files. Perform a hard refresh (hit F5) to resolve this.

sphil's People

Contributors

firgrep avatar ridetoruin 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.