Skip to content

Latest commit

 

History

History
102 lines (76 loc) · 2.64 KB

tech-stack.md

File metadata and controls

102 lines (76 loc) · 2.64 KB

A Literary map of the world. Go to any marker (location) in the world and see which books are written about the place.

🚀 Installation and Setup

Follow these steps to set up LitMap locally:

  1. Clone the Repository

    git clone https://github.com/ram-n/LitMap.git
cd LitMap

  2. Install Dependencies

    • If using a requirements.txt, run: 
      pip install -r requirements.txt
    • For frontend dependencies, ensure they’re installed as needed.

  3. Run the Project Locally

    • If you’re using Firebase Hosting or another server, follow those instructions here.

  4. Open the App

    • Open index.html in your browser to start exploring the map and functionality.
LitMap/
│
├── public/
│   ├── index.html
│   ├── styles/
│   │   └── style.css
│   ├── scripts/
│   │   ├── app.js
│   │   ├── firebase.js
│   │   └── map.js
│   └── assets/
│
├── firebase.json
└── README.md

File Descriptions

1. public/ Folder:

index.html: Your main HTML file that will load the map and interface for adding books. This is the root file that users will access.

  • styles/: CSS Files

  • scripts/:

    • app.js: Central JavaScript file for app logic. This will include UI interactions (handling form submissions, connecting Google Maps and Firebase).
    • firebase.js: Contains the Firebase configuration and initialization code. This is where you'll paste your Firebase config (from earlier).
    • map.js: Handles Google Maps logic, such as loading the map, adding markers, and interacting with map elements.

  • assets/: Place any images or icons your app might need here (like a logo, custom markers, etc.).

2. src/ Folder (optional):

Use this folder if you plan to use a build tool like Webpack or Parcel.

components/: If you start building more advanced UI features (like modals, book lists, etc.), you can organize reusable components here.

  • utils/: Helper functions, like those for formatting data or handling Firebase queries, can go here.

3. Project Files:

  • firebase.json & .firebaserc: Auto-generated files to initialize Firebase in your project. Also contain hosting configurations.

  • package.json: This file tracks project dependencies (like Firebase SDK, if you're using npm).

Data Structure

{
  "location": {
    "lat": 28.6139,
    "lng": 77.2090,
    "name": "New Delhi"
  },
  "books": [
    {
      "title": "Midnight's Children",
      "author": "Salman Rushdie"
    },
    {
      "title": "The White Tiger",
      "author": "Aravind Adiga"
    }
  ]
}