Skip to content

Commit

Permalink
docs: add project image and team members
Browse files Browse the repository at this point in the history
  • Loading branch information
SverreNystad committed Sep 17, 2024
1 parent ace28ba commit 84826c7
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 30 deletions.
93 changes: 63 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,29 @@
<!-- TODO: CHANGE ALL INSTANCES OF "TEMPLATE-README" IN ENTIRE PROJECT TO YOUR PROJECT TITLE-->
# TEMPLATE-README
<!-- TODO: CHANGE ALL INSTANCES OF "CrawlAI" IN ENTIRE PROJECT TO YOUR PROJECT TITLE-->
# CrawlAI


<div align="center">

![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/CogitoNTNU/TEMPLATE-README/ci.yml)
![GitHub top language](https://img.shields.io/github/languages/top/CogitoNTNU/TEMPLATE-README)
![GitHub language count](https://img.shields.io/github/languages/count/CogitoNTNU/TEMPLATE-README)
![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/CogitoNTNU/CrawlAI/ci.yml)
![GitHub top language](https://img.shields.io/github/languages/top/CogitoNTNU/CrawlAI)
![GitHub language count](https://img.shields.io/github/languages/count/CogitoNTNU/CrawlAI)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Project Version](https://img.shields.io/badge/version-0.0.1-blue)](https://img.shields.io/badge/version-0.0.1-blue)

<img src="docs/images/project-logo.webp" width="50%" alt="Cogito Project Logo" style="display: block; margin-left: auto; margin-right: auto;">
<img src="docs/images/crawlai.webp" width="30%" alt="Cogito Project Logo" style="display: block; margin-left: auto; margin-right: auto;">
</div>


<details>
<summary><b>📋 Table of contents </b></summary>

- [TEMPLATE-README](#template-readme)
- [CrawlAI](#crawlai)
- [Description](#description)
- [Getting started](#getting-started)
- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [Testing](#testing)
- [Documentation](#documentation)
- [Team](#team)
- [License](#license)

Expand All @@ -36,53 +37,85 @@
<!-- TODO: In this Section you describe how to install this project in its intended environment.(i.e. how to get it to run)
-->

<!-- TODO: Describe how to configure the project (environment variables, config files, etc.).
### Configuration
Create a `.env` file in the root directory of the project and add the following environment variables:
```bash
OPENAI_API_KEY = 'your_openai_api_key'
MONGODB_URI = 'your_secret_key'
```
-->

### Prerequisites
<!-- TODO: In this section you put what is needed for the program to run.
For example: OS version, programs, libraries, etc.
Before you start, make sure the following tools are installed on your system:
- **Git:** Version control system to clone the project repository [Download Git](https://git-scm.com/downloads)
<!-- - **Docker:** To containerize the application and ensure it runs consistently across different environments [Download Docker](https://www.docker.com/products/docker-desktop) -->
- **Python:** Programming language used to build the application [Download Python](https://www.python.org/downloads/)

-->
- Ensure that git is installed on your machine. [Download Git](https://git-scm.com/downloads)



## Usage
To run the project, run the following command from the root directory of the project:
```bash

python main.py
```
<!-- TODO: Instructions on how to run the project and use its features. -->

## Testing
To run the test suite, run the following command from the root directory of the project:
```bash

pytest
```

## Documentation
- [Developer Setup](docs/manuals/developer_setup.md)


## Team
This project would not have been possible without the hard work and dedication of all of the contributors. Thank you for the time and effort you have put into making this project a reality.


<table align="center">
<tr>
<!--
<td align="center">
<a href="https://github.com/NAME_OF_MEMBER">
<img src="https://github.com/NAME_OF_MEMBER.png?size=100" width="100px;" alt="NAME OF MEMBER"/><br />
<sub><b>NAME OF MEMBER</b></sub>
<a href="https://github.com/jonkor29">
<img src="https://github.com/jonkor29.png?size=100" width="100px;" alt="Jonas Korkosh"/><br />
<sub><b>Jonas Korkosh</b></sub><br />
</a>
</td>
<td align="center">
<a href="https://github.com/AlMinaDO">
<img src="https://github.com/AlMinaDO.png?size=100" width="100px;" alt="AlMinaDO"/><br />
<sub><b>Mina Al-Dolaimi</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Nathaniavm">
<img src="https://github.com/Nathaniavm.png?size=100" width="100px;" alt="Nathaniavm"/><br />
<sub><b>Nathania Muliawan</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Nilsthehacker">
<img src="https://github.com/Nilsthehacker.png?size=100" width="100px;" alt="Nils Henrik Hoelfeldt Lund"/><br />
<sub><b>Nils Henrik Hoelfeldt Lund</b></sub><br />
</a>
</td>
<td align="center">
<a href="https://github.com/Parleenb">
<img src="https://github.com/Parleenb.png?size=100" width="100px;" alt="Parleenb"/><br />
<sub><b>Parleen Brar</b></sub><br />
</a>
</td>
<td align="center">
<a href="https://github.com/SindreFossdal">
<img src="https://github.com/SindreFossdal.png?size=100" width="100px;" alt="SindreFossdal"/><br />
<sub><b>Sindre Fossdal</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/LockedInTheSkage">
<img src="https://github.com/LockedInTheSkage.png?size=100" width="100px;" alt="LockedInTheSkage"/><br />
<sub><b>Skage Reistad</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/tobiasfremming">
<img src="https://github.com/tobiasfremming.png?size=100" width="100px;" alt="Tobias Fremming"/><br />
<sub><b>Tobias Fremming</b></sub>
</a>
</td>
-->
</tr>
</table>

Expand Down
Binary file added docs/images/crawlai.webp
Binary file not shown.

0 comments on commit 84826c7

Please sign in to comment.