SowinskiBraeden/school-management-api
1
0 Fork 0
Code Issues Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
SowinskiBraeden committed 2023-01-13 16:59:00 -08:00
1 parent 0c017082ee
commit cd9685fdf7
2 files changed
+3 -27
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

CONTRIBUTING.md
-13
View File
@@ -1,13 +0,0 @@
<!-- CONTRIBUTING -->
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Clone the Project
2. Create your Feature Branch (`git checkout -b update/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin update/AmazingFeature`)
5. Open a Pull Request
README.md
+3 -14
View File
@@ -5,7 +5,6 @@ The backend API for a school management system accessible by staff and students.
***Explore the docs »***
* [Getting Started](#getting-started)
* [Usage/Documenation](#usage)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
@@ -40,18 +39,15 @@ To start off on this new set of features, I decided to tackle the largest and mo
schedule generation. This algorithm generates a master timetable as well as updates the student schedule.
All the while keeping track of any errors for admins to handle personally. This can be found in `testing`,
The [schedule generation](/test/scheduleGenerator) file is of the latest version, version 3. Though this has
been moved to its own [repository](https://github.com/SowinskiBraeden/schedule-generator).
been moved to its own [repository](https://github.com/SowinskiBraeden/ScheduleGeneratorApp).
## Related Work
After the majority completion of vital api functionalities such as the ability to update information, create new
information, generate information, delete information, authentication etc. I have created a new repository
for the next frontier of this project. I am now concurrently working on the [School Management Website](https://github.com/SowinskiBraeden/school-management).
for the next frontier of this project. I am now concurrently working on the [School Management Website](https://github.com/SowinskiBraeden/school-management-vue).
The School Management Website, is going to be written using the [Next.js](https://nextjs.org/) framework. Previously the plan
was to use Vue.js, and I started work on the project, which I have now decided to discontinue and archive it [here](https://github.com/SowinskiBraeden/school-management-archived). I now plan to start from scratch and use Next.js as I believe it is more
suited for this project and is more popular with its use of React.js over Vue.js. The new repository can be found [here](https://github.com/SowinskiBraeden/school-management).
<br>
The School Management Website, is going to be written using the [Vue.js](https://vuejs.org/) framework.
## Getting Started
@@ -107,13 +103,6 @@ The usage for this API is in the name, school management, it's not an easy task
To see a full list of features and how to use the system, read the [documentation](DOCUMENTATION.md)
<!-- CONTRIBUTING -->
## Contributing
Please refer to [CONTRIBUTING](CONTRIBUTING.md) for contributing to the project.
<!-- LICENSE -->
## License