Skip to content

Commit

Permalink
Readme (#51)
Browse files Browse the repository at this point in the history
Add README
  • Loading branch information
SamuTheCoder authored May 24, 2024
1 parent d37ccf9 commit 40d38bf
Show file tree
Hide file tree
Showing 54 changed files with 16,468 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
![osm-logo](osm-mec-logo.png)

<div align="center">

>A Multi-access Edge Computing implementation on OSM


<br>

**<kbd> <br> [Get Started/Wiki](https://samuthecoder.github.io/osm-mec-wiki/) <br> </kbd>**
**<kbd> <br> [API Docs](https://app.swaggerhub.com/apis-docs/HenriqueCruz/oss-nb_api/1.0.0#/) <br> </kbd>**
**<kbd> <br> [Website](https://pedrodsferreira.github.io/osm-mec/) <br> </kbd>**
</div>


<!----------------------------------------------------------------------------->

## Contributors

#### [Afonso Castanheta](https://github.com/castanheta)
#### [Francisco Cardita](https://github.com/FranciscoCardita)
#### [Henrique Cruz](https://github.com/hmecruz)
#### [Luís Oliveira](https://github.com/luisOliveira-22)
#### [Pedro Ferreira](https://github.com/PedroDSFerreira)
#### [Samuel Teixeira](https://github.com/SamuTheCoder)
20 changes: 20 additions & 0 deletions docs/wiki/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
41 changes: 41 additions & 0 deletions docs/wiki/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
3 changes: 3 additions & 0 deletions docs/wiki/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
12 changes: 12 additions & 0 deletions docs/wiki/docs/api_related.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# API Docs

#### Discover the functionalities offered by our platform through our API documentation:

- [**OpenAPI Specification**](https://app.swaggerhub.com/apis-docs/HenriqueCruz/oss-nb_api/1.0.0#/)

![Example Image](./images/openapi.png)





Loading

0 comments on commit 40d38bf

Please sign in to comment.