Skip to content

From the Prescription Free Academy. Part of the Trading Exchange Collaborative Learning Program.

License

Notifications You must be signed in to change notification settings

pecknigel/open-exchange-tickers

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Open Exchange Tickers

This is an implementation of a data service for the Trading Exchange Collaborative Learning Program from the Prescription Free Academy of Web Development and Software Engineering.

If you want to create your own version of this, there’s a practice project that can help at Exchange Tickers Practice Project.

It is a small service for generating trading tickers that change price over time without any actual markets needing to exist.

It’s intended to behave like actual markets could and give the appearance of active markets (as long as you don’t look too closely).

What’s all this about?

It’s all part of a collaborative project for learning web development and software engineering. All backed by an experienced software engineer and teacher who has stepped away after twenty years in software development to concentrate on teaching.

Mentoring is available as needed, seven days a week.

Getting Started

See the program repo for info on getting started and about this learning program in general.

How to Try Out the Project

(note this is not "running" or "using" the project - that's discussed next)

Clone the repository and install the dependencies.

git clone git@github.com:pecknigel/open-exchange-tickers.git
npm install

Build the project.

npm run build

This will create a dist directory with the compiled project.

In order to try out the project, there are a few ways that you can do it. Here are the scripts.

IMPORTANT: See the individual scripts in package.json to know what these run. See the script files themselves for details of what they actually do (they are liberally commented).

Command Line Output

Like how it's actually used.

npm run exec-cmd

Log

See how values change over time.

npm run exec-log

Raw Log

See how values change over time including internal details

npm run exec-raw-log

How to Use the Project

[More info coming]

Specification

See Data Access Layer for more about the system layer that this project implements.

See Data Access Layer Interface Agreements for specification of the interface that this should provide.

Project Management and Discussion

We’re looking to keep project management simple and housed on GitHub.

It’s currently the only places for discussion too, at least publicly.

GitHub Issues
Issues · pecknigel/open-exchange-tickers

Contributions

Contributions are welcome. See CONTRIBUTING.md (currently a stub).

Licensing

This project is dual licensed. See LICENSE.txt.