Skip to content

alexcurtis/project10k-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project10K Backend

Live Demo

A live demo can be found at: http://13.60.202.2/

You can sign in a play around using the following credentials:

  • Username - alexander@localhost
  • Password - hal9000

Background

Project10k is a personal project. It was built as a development playground, to experiment with new design patterns, methodologies, technologies and frameworks. At its heart, it is a fintech research tool for equity analysts. Project10K is a research tool, that allows analysts and investors to create comprehensive research notes (Journals) on public companies. Currently, it features powerful highlight and citation tools allowing users to reference back to original company filings.

More to come!

Whilst still in its early stages it features:

  • User Authentication and Authorisation. Login / Logout through JWT
  • Support for multiple users and accounts
  • Workspaces (Add / Remove / Rename)
  • Interactive Journals, organised via a node graph
  • SEC Company + Document search
  • Notion-Style Editor
  • SEC Document highlighting and citations
  • Citation references in editor with hyperjump to source.

This project uses the following technologies:

  • NextJS
  • Microservices (TCP)
  • Typescript
  • Apollo GraphQL
  • JWT + Guards via Passport
  • Mongoose + MongoDB
  • Docker
  • Nginx
  • AWS

Getting Started

There are 2 microservices: api and ussec:

  • api - GraphQL api for the frontend
  • ussec - Data aggregator and connect for the US Sec EDGAR database
  • Each have seperate, decoupled NestJS projects, with their own top level folders.

Run the NestJS development server (for each microservice):

yarn install
yarn run start:dev

Note - The frontend project has an Nginx setup that connects the frontend and microservices together. It is used for both local development and on the AWS production deployment (live demo link above).

A Quick Run Down

  • This project uses the Next.js page system. All of the code can be found in src/app.
  • Login, Logout are small independent pages.
  • The main meat and bones of the project can be found in the Platform folder.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published