Skip to content
This repository has been archived by the owner on Oct 1, 2024. It is now read-only.

created data directory, moved glossary there as per Laurel's architecture #5

Merged
merged 1 commit into from
Mar 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,20 @@ Welcome to the Web3 Glossary!
This project aims to build a comprehensive glossary of terms and concepts related to the Web3 ecosystem. It includes definitions, explanations, and examples to help users understand key concepts in the world of Web3 technologies. It is a global, ever-growing source of web3 jargon and vocabulary.

## Project Structure
- **src**: Contains the source code for the glossary scraper tool.
- **locales**: Holds localization files for internationalization.
- **data**: Stores data collected by the scraper tool.
- **README.md**: This file, providing an overview of the project.
- **`./src`**: Contains the source code for the glossary frontend.
- **`locales`**: Holds localization files for internationalization.
- **`./data`**: Stores data collected by the scraper tool.
- **`README.md`**: This file, providing an overview of the project.

## Getting Started
To get started with the project, follow these steps:
1. Clone the repository.
2. Install the necessary dependencies.
3. Run the scraper tool to collect data.
4. Explore the collected data in the `data` directory.
2. Install the necessary dependencies by running `npm install`
3. Run the app by running `npm start`

## Scraping new terms
4. Run the [scraper tool](https://github.com/mapachurro/term-scraper) to collect data.
5. Explore the collected data in the `data` directory.

## Contributing
Contributions to the glossary project are welcome! Feel free to submit pull requests with new terms, definitions, or improvements to existing content.
Expand Down
Loading