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

Commit

Permalink
Merge pull request #5 from i18nlaurel/cleanup-2
Browse files Browse the repository at this point in the history
created data directory, moved glossary there as per Laurel's architecture
  • Loading branch information
mapachurro authored Mar 13, 2024
2 parents 7e7ab02 + bd85a5c commit ccd1e77
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
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
File renamed without changes.

0 comments on commit ccd1e77

Please sign in to comment.