Merge pull request #79 from vantage-ola/new-docs

new-docs

LICENSE

@@ -1,22 +1,15 @@
-MIT License (Non-Commercial)
-
-Copyright (c) 2023 Oluwasanya Olaoluwa, Chidozie David
+Copyright (c) 2024 Oluwasanya Olaoluwa
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish and distribute 
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
-**Non-Commercial Clause:**
-The Software may not be used for commercial purposes. Commercial purposes
-include, but are not limited to, selling, licensing, renting, or any activity
-that generates revenue.
-
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

README.md

@@ -1,15 +1,59 @@
-![logo](./tracknow/img/new_tracknow_black.png)
+<br/>
+<p align="center">
+  <a href="https://github.com/vantage-ola/track-now">
+    <img src="./tracknow/img/logo.png" alt="Logo" width="80" height="80">
+  </a>
+  <h3 align="center">track now</h3>
+  <p align="center">
+    share your racing moments
+    <br/>
+    <br/>
+    <a href="https://github.com/vantage-ola/track-now"><strong>Explore the docs »</strong></a>
+    <br/>
+    <br/>
+    <a href="https://tracknow.vantageola.com.ng/">View Alpha Version</a>
+    .
+    <a href="https://github.com/vantage-ola/track-now/issues">Report Bug</a>
+    .
+    <a href="https://github.com/vantage-ola/track-now/issues">Request Feature</a>
+  </p>
+</p>
+
+![Contributors](https://img.shields.io/github/contributors/vantage-ola/track-now?color=green) ![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/vantage-ola/track-now)
+![GitHub License](https://img.shields.io/github/license/vantage-ola/track-now)
+![GitHub Tag](https://img.shields.io/github/v/tag/vantage-ola/track-now)
+
+## Table Of Contents
+
+- [About the Project](#about-the-project)
+- [Getting Started](#getting-started)
+- [Roadmap](#roadmap)
+- [Contributing](#contributing)
+- [License](#license)
+
+## About The Project
+
+![Screen Shot](./tracknow/img/v1.0.0.alpha2.png)
+
+TRACK NOW is a application by simracers for simracers. A platform to share racing moments with others.
 
+Feel free to contribute by suggesting improvements and ideas to make TRACK NOW even better.
 
-## OVERVIEW
-
-Welcome to TRACK NOW Repository! This repository contains the source code of the tracknow application. 
-TRACK NOW lets you share your racing moments with the world. 
+## Getting Started
+- [BACKEND API README](https://github.com/vantage-ola/track-now/blob/main/tracknow/backend/README.md)
+- [WEB README](https://github.com/vantage-ola/track-now/blob/main/tracknow/web/README.md)
+## Roadmap
 
-Feel free to contribute by suggesting improvements and ideas to make TRACK NOW even better.
+See the [open issues](https://github.com/vantage-ola/track-now/issues) for a list of proposed features (and known issues).
 
+### Creating A Pull Request
 
-### License
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
 
-TRACK NOW is licensed under the [MIT License (Non-Commercial)](https://github.com/vantage-ola/track-now/blob/main/LICENSE), ensuring that the information is freely accessible and shareable.
+## License
 
+Distributed under the MIT License. See [LICENSE](https://github.com/vantage-ola/track-now/blob/main/LICENSE.md) for more information.

tracknow/backend/README.md

@@ -24,6 +24,8 @@ Fill in the environment variables
     TESTING_PG=postgres://username:password@hostname:port/testdatabasename #dont use the same database, create a new one for testing !
     TESTING_JWT_SECRET_KEY=xxxxxxxxx9612c6808732
     TESTING_SECRET_KEY=xxxxxxxx104af944ae4f60
+    API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
 ```
 ### 4. Create the database and start the server.
 ``` shell